====== Формат взаимодействия API ======
WaspAce API работает в формате [[http://ru.wikipedia.org/wiki/JSON|JSON]] по адресу http://api.waspace.net
===== Коды взаимодейтсвий =====
* [[ru:api:format:opcodes]]
* [[ru:api:format:serverresponses]]
* [[ru:api:format:generalerrors]]
===== Формат работы с POST запросами =====
== Запрос ==
Тело запроса должно содержать следующую строку с JSON-объектом:
v={
"Action":,
"Data":{
}
}
//Где//
* //// - код запроса
* //// - данные, зависящие от кода операции.
* //"v="// - используется для работы с JavaScript.
== Ответ ==
В теле ответа сервера будет содержаться строка:
===== Формат работы с GET запросами =====
== Запрос ==
Строка запроса должна выглядеть следующим образом:
http://api.waspace.net//{}
//Где//
* //// - код запроса
* //// - данные, зависящие от кода операции.
== Ответ ==
В теле ответа сервера будет содержаться строка:
//Где//
* //// - ответ сервера в формате JSON.
==== Типы ответов сервера ====
== Запрос успешно выполнен ==
{
"Status": ,
"Data": {
}
}
//Где//
* //// - статус выполнения запроса, означающий успешное выполнение
* //// - данные в формате JSON, содержание которых зависит от запроса. Если данные в ответе не требуются, то объект Data в ответе будет отсутствовать.
== Запрос не выполнен, произошла общая ошибка ==
{
"Status":,
"Error":
}
//Где//
* //// - статус ответа, означающий общую ошибку
* //// - один из кодов общих ошибок.
== Запрос не выполнен, произошла ошибка по запросу ==
{
"Status":,
"Error":
}
//Где//
* //// - статус ответа, означающий ошибку по запросу
* //// - один из кодов ошибок по запросу.
===== Дополнительная информация =====
* Кодировка запросов и ответов - UTF-8
* Ответ от сервера приходит в формате JavaScript encodeURI.
* Запрос на сервер может быть также закодирован функцией, аналогичной JavaScript encodeURI.