Все ответы имеют тип контента application/json и следуют общепринятым кодам состояния:

Статус Описание
200 Успешный запрос
401 Неверный ключ API
403 Доступ запрещен
404 Ресурс не существует
405 Недопустимый метод запроса
422 Валидация параметров не пройдена
500 Внутренняя ошибка сервера

Данные успешного ответа всегда находятся в ключе data, например:

{
    "data": {
        "id": 123,
        "name": "Example",
        "active": true
    }
}

Массивы данных могут возвращаться постранично:

{
    "data": [],
    "links": {
        "first": "https://simex.global/api/example?page=1",
        "last": "https://simex.global/api/example?page=5",
        "prev": "https://simex.global/api/example?page=2",
        "next": "https://simex.global/api/example?page=4"
    },
    "meta": {
        "current_page": 3,
        "from": 31,
        "last_page": 5,
        "path": "https://simex.global/api/example",
        "per_page": 15,
        "to": 45,
        "total": 75
    }
}

В случае ошибки с кодом 4** сообщение помещается в ключ message, например:

{
    "message": "Unauthenticated."
}

Пример ответа с кодом 422 - неверные параметры запроса:

{
    "message": "The given data was invalid.",
    "errors": {
        "pair": [
            "The pair field is required."
        ]
    }
}

назад далее