Интеграции

Адаптер для взаимодействия с REGOS:API; перенаправляет запросты на REGOS:API.

Взаимодействие с API адаптером осуществляется по протоколу HTTP методом POST. Данные передаются в теле запроса в формате JSON.

Endpoint

integration.regos.uz/api/v1/model/action
Переменные в эндпоинте предназначены для выбора метода API:

• method - Модель данных API;
• action - Действие с моделью API.

Headers (Заголовки)

Обязательные заголовки всх методов POST

Входные параметры

У каждого метода API разные входные параметры в теле запроса. Тело запроса может быть JSON объектом, массивом или параметром.

Пример запроса (Объект)

{
    "id": 1,
    "field": "example",
}

Пример запроса (Массив)

[
    {
        "id": 1,
        "name": "example",
    }
]

Пример запроса (Параметр)

"id": 1

Выходные параметры

Успешное выполнение

Модель тела ответа, в случае успешного выполнения метода:

Пример ответа (Объект)

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": {
        "id": 1,
        "name": "example"
    }
}

Пример ответа (Массив)

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "example",
        }
    ]
}

Пример ответа (Переменная)

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": "example"
}

Пример ответа (Null)

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": null
}

Ошибка при выполнении

Модель тела ответа, в случае логической ошибки при выполнении метода:

Error

Модель, описывающая логическую ошибку при выполнении метода:

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

Пример тела ответа, в случае логической ошибки при выполнении метода:

{
    "ok": true,
    "result": {
        "error": 1234,
        "description": "Something went wrong!",
    }
}