Главная страница / Общая информация

Общая информация

• Версия API: 1.2.0
• Базовый URL тестовой среды — https://avia-api-test.bookhara.uz
• В качестве транспорта используется HTTP протокол.
• Все ответы приходят в JSON.

Структура ответа

Каждый ответ содержит следующие поля:

1. request_id — string, уникальный идентификатор запроса. В случае возникновения ошибки по его номеру можно идентифицировать проблему, обратившись в support.
2. created_at — string, дата и время формирования ответа в UTC.
3. message — string, комментарий к ответу.
4. data — array, блок данных.

Поле ответа может быть null. Это означает, что для этого параметра нет данных, и фактически данные могут быть любыми в пределах допустимого для поля.

Пример ответа:

{
    "request_id":"AhyUWPqIAXIXmdbJSIiqDvW3UHojAgqgrcEJ10K3",
    "created_at":"2021-04-06 12:38",
    "message":"The request was completed successfully.",
    "data":[
        {
            "id":"AvWvnF1Ef4OrUhzqF3we4ry5HZldQLyq",
            "price":{
                "amount":125877.74,
                "currency":"UZS"
            },
            ...
        },
        ...
    ]
}

Обработка ошибок

В случае успешного выполнения запроса сервер вернет код ответа HTTP 200 OK.

Во всех остальных случаях HTTP код ответа будет соответствовать текущей ошибке выполнения.

Кроме этого, тело ответа может содержать описание ошибки, состоящее из нескольких элементов:

1. error_code — integer, код ошибки. Описание ошибок указаны в справочнике.
2. message — string, текстовое описание ошибки.
3. errors — array, необязательный массив с описанием ошибок валидации.

Пример ответа в случае ошибки:

{
    "request_id":"AhyUWPqIAXIXmdbJSIiqDvW3UHojAgqgrcEJ10K3",
    "created_at":"2021-04-06 12:38",
    "error_code":8,
    "message":"The given data was invalid.",
    "errors":{
        "service_class":[
            "The service class field is required."
        ],
        "children":[
            "The children field is required."
        ]
    }
}