Результаты API

Структура успешного результата

Успешный результат API выглядит так:

{
        "status": 0,
        "result": "API result"
}

В зависимости от вызова API result может содержать любой тип контента (строка, число, массив, объект и т.д.).

Пример числового результата (например, количество пользователей):

{
        "status": 0,
        "result": 10
}

Пример результата в виде объекта (например, пользователь):

{
        "status": 0,
        "result": {
                "name": "Some user",
                "username": "apiexample",
                "email": "user@example.com"
        }
}

Структура результата ошибки

Когда вызов API не удаётся, результат будет выглядеть так:

{
        "status": -1,
        "message": "The reason the API call failed"
}

Коды статуса по умолчанию

Поле status всегда содержит число, представляющее результат. Любое значение, отличное от 0, считается ошибкой.

• 0: это успешный результат

• -1: это общая ошибка

• -20: токен аутентификации пользователя отсутствует, недействителен или истёк

• -30: ключ API был отключён

• -31: ключ API неактивен

• -32: ключ API недействителен

Разработчики могут реализовать свои собственные коды статуса для представления различных состояний ошибок, чтобы запрос не должен был полагаться на сообщение об ошибке, чтобы узнать, что пошло не так.

Примечание

result и message могут содержать сообщения на разных языках. Это зависит от языка пользователя при использовании аутентифицированных пользователем вызовов API или языка сайта для других вызовов API. Имейте в виду, что язык может измениться, либо пользователем, либо администратором сайта для языка сайта.