Введение в API » Обращение к API
На этой странице описывается, как получать информацию о ресторане с помощью API РестоБазы.
RestoBaza PHP SDK
Для обращения к API РестоБазы используйте официальную библиотеку для PHP, которую вы можете скачать с github по этой ссылке https://github.com/ivankd/restobaza-php-sdk. На данный момент, документация рассчитана на PHP разработчиков, и все примеры в документации используют эту PHP библиотеку.
Тестовый ресторан
С помощью нижеуказанных данных вы можете обращаться к тестовому ресторану, в котором заполнены все разделы. Эти данные удобно использовать для тестирования API, а также во время разработки сайта ресторана.
$config = array( "co_id" => 1, "app_id" => 6, "app_secret" => 'tc1a7g8b12dbd445' );
Запрос к API с помощью RestoBaza PHP SDK
После того, как вы скачали RestoBaza PHP SDK, вы можете обращаться к API РестоБазы. Ниже дан пример, с помощью которого вы можете получить 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('news/getmany', $api_params);
var_dump($rb_response);
?>
Все обращения к API РестоБазы осуществляются через метод api:
$rb_response = $restobaza->api('news/getmany', $api_params);
Синтаксис метода api:
array api ( str $method, array $parameters )
Параметры метода api:
$method - строка с названием метода.
$parameters - массив с параметрами.
Метод api возвращает массив.
В этой документации вы найдете описания доступных методов, описания параметров для этих методов, готовые примеры обращений к API, а также описание ответов для каждого метода.
Ответ на запрос
API отдает информацию в формате JSON. При обращении к API с помощью Restobaza PHP SDK, JSON преобразуется в обычный PHP массив. Для удобства восприятия, ответы API в документации используют формат JSON. Например, с помощью запроса, который указан выше, Вы получите список новостей тестового ресторана:
{
"pagination": {
"page": 1,
"limit": 10,
"total_pages": 2,
"total_items": 15
},
"list": [
{
"id": "66",
"name": "Name",
"description": "Description ...",
"cover": {
"100": {
"width": 100,
"height": 67,
"source": "http://img.restobaza_local.ru/co/co25/news/66/25_news_66_100_5179421118499.jpg"
},
"150": {
"width": 150,
"height": 100,
"source": "http://img.restobaza_local.ru/co/co25/news/66/25_news_66_150_5179421118499.jpg"
},
"200": {
"width": 200,
"height": 133,
"source": "http://img.restobaza_local.ru/co/co25/news/66/25_news_66_200_5179421118499.jpg"
},
"300": {
"width": 300,
"height": 200,
"source": "http://img.restobaza_local.ru/co/co25/news/66/25_news_66_300_5179421118499.jpg"
},
"500": {
"width": 500,
"height": 333,
"source": "http://img.restobaza_local.ru/co/co25/news/66/25_news_66_500_5179421118499.jpg"
},
"1024": {
"width": 1024,
"height": 681,
"source": "http://img.restobaza_local.ru/co/co25/news/66/25_news_66_1024_5179421118499.jpg"
}
},
"created_time": "2013-04-25T17:07:25+00:00",
"images_count": "2"
},
{...}
]
}
Получив ответ, вы можете отображать информацию на сайте ресторана в нужной вам верстке.
Подключение к вашему ресторану
После того, как вы создали сайт ресторана, вы можете заменить данные тестового ресторана на данные нужного вам ресторана. Чтобы получать информацию из нужного вам ресторана, вам необходимо знать уникальный номер ресторана (co_id), уникальный номер приложения (app_id), а также секретный ключ приложения (app_secret).
Все эти параметры вы можете найти в разделе "Основное" в панели управления рестораном. Если у вас нет доступа к управлению рестораном на РестоБазе, попросите сотрудников ресторана прислать вам эти данные.
