ApiKey

Материал из post-API.ru
Перейти к: навигация, поиск

"apikey" - является частью запроса web-сервисов API. Ключ формируется в Личном кабинете пользователя на сайте проекта.

Активный ключ

Ключ передается в параметре apikey запроса POST любого web-сервиса.

В массивах-ответах возвращаемых web-сервисами, передаются два значения, которые необходимо проверять при выводе результатов клиентам: "access" и "access_status".

  • access_status может принимать два значения - "ok" и "forbidden". Значение "ok" означает, что проверка прав доступа прошла успешно, и web-сервис выполнил все необходимые алгоритмы. Значение "forbidden" указывает на проблемы с доступом, причина которых детализируется в поле "access".
  • access может принимать значения:
    • "active" Ключ успешно прошел проверку.
    • "unknown" Внутренняя ошибка сервиса, не связанная с ключом. Проверки ключа не проводилось
    • "wrongparam" Неправильный входной параметр (только для city2index.php). Означает, что для тестового ключа 'dev' передан не фрагмент города "Санкт-Петербург".
    • "notexist" Ключ указан неправильно. В базе данных активных или не активных ключей такой ключ отсутствует.
    • "blocked" Ключ заблокирован административно. За дополнительными разъяснениями нужно обращаться по адресу технической поддержки.

Примеры

Фрагмент возвращаемого массива-ответа.

   Array
   (
       [id] => ALL
       [api_ver] => 1.0
       [access_status] => ok
       [access] => active
       [executed_time] => 0.026094913482666
       ...

Фрагмент возвращаемого массива-ответа

   Array
   (
       [id] => ALL
       [api_ver] => 1.0
       [access_status] => forbidden
       [access] => notexist
       [executed_time] => 0.0018842220306396
       ...

Тестовый ключ

В целях отладки взаимодействия внешнего Интернет-магазина с API возможно использование тестового ключа "dev" (см. выше в примерах), при использовании которого скрипты работают в полном объеме, но только для индекса 656056 (Барнаул, Алтайский край).