Все запросы к API осуществляются методом POST. Для отправки запросов к API используется следующий Endpoint: https://api.regos.uz.
Каждый запрос должен содержать обязательные заголовки(Headers):
При корректном выполнении метода сервер вернет ответ с кодом 200. Иные коды ответа, могут возникать при ошибке на стороне сервера.
Выходные параметры:
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
ok | bool | Обязательный | True/False – метка успешного ответа |
Result | Object, array of objects | Обязательный | Массив возвращаемых данных. Единичное значение либо массив данных |
Пример успешного ответа (Object)
{
"ok": true,
"result":
{
"session_id": 1
}
}
Пример успешного ответа (Array of Objects)
{
"ok": true,
"result":
[
{
"id": 1,
"name": "зелёный",
"last_update": 1534151629
}
]
}
Пример ответа с ошибкой
{
"ok": false,
"result":
{
"error": 9000,
"description": "Ошибка авторизации. Отсуствует заголовок Token"
}
}
Полный список возможных ошибок