Наверх
ресторанам разработчикам веб-дизайнерам
РестоБаза API
 
 
 
API
Методы

Разделы API » Партнеры

На этой странице описываются методы для получения информации о партнерах ресторана:

partners/getmany

Описание метода

Метод необходим для получения списка партнеров.

Параметры метода

Название параметра Обязательный Описание и возможные значения Пример значения
v да

Версия метода. Текущая версия метода - 2.

2
page да

Номер страницы с партнерами. Номер первой страницы - 1.

1
limit да

Количество партнеров на одну страницу. Максимальное значение - 20.

10

Пример запроса

Получить 10 партнеров ресторана: 


<?php

include ('restobaza.class.php');  

$config = array(
  "co_id" => 1,
  "app_id" => 6,
  "app_secret" => 'tc1a7g8b12dbd445'
);

$restobaza = new Restobaza($config);

$api_params = array(
  "v" => 2,
  "page" => 1, 
  "limit" => 10
);

$rb_response = $restobaza->api('partners/getmany', $api_params);

?>

Пример ответа

Если в ресторане нет партнеров, то в ответе будет пустой массив. Если партнеры есть: 

{
    "pagination": {
        "page": 1,
        "limit": 2,
        "total_pages": 1,
        "total_items": 2
    },
    "list": [
        {
            "id": "38",
            "name": "name",
            "link": "http://link",
            "description": "text",
            "cover": {
                "100": {
                    "width": 100,
                    "height": 150,
                    "source": "http://img.restobaza_local.ru/co/co25/partners/38/25_partners_38_100_517a704ff010f.jpg"
                },
                "150": {
                    "width": 150,
                    "height": 225,
                    "source": "http://img.restobaza_local.ru/co/co25/partners/38/25_partners_38_150_517a704ff010f.jpg"
                },
                "200": {
                    "width": 200,
                    "height": 300,
                    "source": "http://img.restobaza_local.ru/co/co25/partners/38/25_partners_38_200_517a704ff010f.jpg"
                },
                "300": {
                    "width": 300,
                    "height": 450,
                    "source": "http://img.restobaza_local.ru/co/co25/partners/38/25_partners_38_300_517a704ff010f.jpg"
                },
                "500": {
                    "width": 500,
                    "height": 750,
                    "source": "http://img.restobaza_local.ru/co/co25/partners/38/25_partners_38_500_517a704ff010f.jpg"
                },
                "1024": {
                    "width": 1024,
                    "height": 1536,
                    "source": "http://img.restobaza_local.ru/co/co25/partners/38/25_partners_38_1024_517a704ff010f.jpg"
                }
            }
        },
        {...}
    ]
}

Описание ответа

Список партнеров содержится в ключе list, который представляет собой массив из объектов album.

Объект album:

Название поля Может быть пустым Описание Тип переменной
id

нет

Уникальный номер партнера.

string

name

нет

Название партнера.

string

link

да

Ссылка на сайт партнера.

string

description

нет

Описание партнера.

string

cover

да

Обложка партнера.

Ключи в массиве - 100, 150, 200, 300, 500, 1024 - обозначают максимальную ширину изображения.

Минимальная гарантированная ширина изображения - 200 пикселей. Т.е. изображение в ключах 300, 500, 1024 могут иметь ширину меньше заявленной.

Изображения не имеют фиксированной высоты.

ассоциативный array

Название поля Может быть пустым Описание Тип переменной
source

нет

Абсолютный URL адрес фотографии.

string

width

нет

Ширина фотографии в пикселях.

string

height

нет

Высота фотографии в пикселях.

string

Объект pagination содержит необходимую информацию для создания страниц с партнерами:

Название поля Может быть пустым Описание Тип переменной
page

нет

Значение, которое было передано в параметре page в запросе. Обозначает номер текущей страницы.

string

limit

нет

Значение, которое было передано в параметре limit в запросе. Обозначает максимальное количество партнеров для одной страницы.

string

total_pages

нет

Общее количество страниц с партнерами в ресторане.

string

total_items

нет

Общее количество партнеров в ресторане.

string