Перейти к содержимому

Состояние работы сервиса

GET
/state
curl --request GET \
--url 'https://app.mybi.ru/api/v2/state?token=<token>'

Возвращает состояние сервиса. Можно использовать для проверки доступности API перед массовыми запросами.

Сервис работает в штатном режиме

MIME-типapplication/json

Стандартный ответ

object
result

Результат операции

string
message

Сообщение операции

string
data

Дополнительные данные операции

object
key
дополнительные свойства
string
items

Элементы результата

Array<object>
object

Пример сгенерировано

{
"result": "example",
"message": "example",
"data": {
"additionalProperty": "example"
},
"items": [
{}
]
}

Ошибка авторизации

MIME-типapplication/json
object
status

Код ошибки

integer
error

Текст ошибки

string

Пример сгенерировано

{
"status": 1,
"error": "example"
}