Введение в API » Ошибки

На этой странице описывается способ обработки ошибок API.

Введение

Restobaza PHP SDK использует механизм исключений, и может "бросать" ошибки по разным причинам. Например, если в запросе не был указан обязательный параметр, если были использованы неправильные данные для подключения и т.д. Мы настоятельно рекомендуем "перехватывать" эти ошибки.

<?php

try {
  // Обращение к API
} catch (RestobazaApiException $e) {
  // Если возникла ошибка при обращении к API
  $rb_error = $e->getError();
}

?>

Пример кода для обработки ошибок

<?php

try {
  
  // Создаем экземпляр
  
  $config = array(
    "co_id" => 1,
    "app_id" => 6,
    "app_secret" => 'tc1a7g8b12dbd445', 
    "test_errors" => true // false true
  );
  
  $restobaza = new Restobaza($config);
  
  // Обращаемся к API 
  
  $api_params = array(
    "v" => 2,
    "page" => 1, 
    "limit" => 10
  );
  
  $rb_response = $restobaza->api('news/getmany', $api_params);
  
  // Если ошибок не возникло, то здесь будет ответ с данными с РестоБазы
  print_r($rb_response);


} catch (RestobazaApiException $e) {
  
  // Если при создании экземпляра или при обращении к API возникла ошибка
  // то контроль переходит в этот блок, где можно получить информацию об ошибке
  // и вывести ошибку пользователю
  
  // получаем ифнормацию об ошибке
  $rb_error = $e->getError();
  
  // выводим информацию 
  print('Код ошибки:' . $rb_error['error_code'] . "\n");
  print('Описание ошибки:' . $rb_error['error_description'] . "\n");
  
}


?>

Описание ответа при ошибке

Название поля	Может быть пустым	Описание	Тип переменной
error_code	нет	Уникальный номер ошибки.	string
error_description	нет	Развернутое описание ошибки на английском.	string

Тестирование ошибок

После создания сайта рекомендуется проверить то, как перехватываются ошибки в вашем коде, и что происходит, если Restobaza PHP SDK "бросает" ошибку.

Чтобы искустенно заставить Restobaza PHP SDK всегда "выбрасывать" ошибки для тестирования ошибок, просто добавьте параметр test_errors со значением true при создании экземпляра объекта, как показано в примере выше.

Некоторые коды ошибок

Ниже описаны некоторые коды ошибок при подключении к API.

Номер ошибки	Описание ошибки
1, 2, 3, 4	Неправильно указан метод API. Возможно, Вы просто допустили опечатку в названии метода, или такого метода не существует. Поробуйте скопировать название метода из документации.
23	Не указан один из следующих параметров при создании экземпляра объекта: 'app_id', 'co_id', 'app_secret';