Содержание

Формат взаимодействия API

WaspAce API работает в формате JSON по адресу http://api.waspace.net

Коды взаимодейтсвий

Формат работы с POST запросами

Запрос

Тело запроса должно содержать следующую строку с JSON-объектом: 

v={
 "Action":<ACTION_CODE>,
 "Data":{
  <ACTION_DATA>
 }
}

Где

  • <ACTION_CODE> - код запроса
  • <ACTION_DATA> - данные, зависящие от кода операции.
  • «v=» - используется для работы с JavaScript.
Ответ

В теле ответа сервера будет содержаться строка: 

<head><script>window.name="<RESPONSE_JSON_OBJECT>"</script></head>

Формат работы с GET запросами

Запрос

Строка запроса должна выглядеть следующим образом: 

http://api.waspace.net/<ACTION_CODE>/{<ACTION_DATA>}

Где

  • <ACTION_CODE> - код запроса
  • <ACTION_DATA> - данные, зависящие от кода операции.
Ответ

В теле ответа сервера будет содержаться строка: 

<RESPONSE_JSON_OBJECT>

Где

  • <RESPONSE_JSON_OBJECT> - ответ сервера в формате JSON.

Типы ответов сервера

Запрос успешно выполнен
{
 "Status": <SR_SUCCESS>,
 "Data": {
  <RESPONSE_DATA>
 }
}

Где

  • <SR_SUCCESS> - статус выполнения запроса, означающий успешное выполнение
  • <RESPONSE_DATA> - данные в формате JSON, содержание которых зависит от запроса. Если данные в ответе не требуются, то объект Data в ответе будет отсутствовать.
Запрос не выполнен, произошла общая ошибка
{
 "Status":<SR_GENERAL_ERROR>,
 "Error":<GENERAL_ERROR_CODE>
}

Где

  • <SR_GENERAL_ERROR> - статус ответа, означающий общую ошибку
  • <GENERAL_ERROR_CODE> - один из кодов общих ошибок.
Запрос не выполнен, произошла ошибка по запросу
{
 "Status":<SR_QUERY_ERROR>,
 "Error":<QUERY_ERROR_CODE>
}

Где

  • <SR_QUERY_ERROR> - статус ответа, означающий ошибку по запросу
  • <QUERY_ERROR_CODE> - один из кодов ошибок по запросу.

Дополнительная информация

  • Кодировка запросов и ответов - UTF-8
  • Ответ от сервера приходит в формате JavaScript encodeURI.
  • Запрос на сервер может быть также закодирован функцией, аналогичной JavaScript encodeURI.