Описание

Управление боксами можно осуществлять через ПУ или через наше API.
Для вызова метода API нужно отправить POST-запрос с параметрами метода по протоколу HTTP.

Запрос следует отправлять по адресу:
https://api.from.sh/sprintbox/{object}/{action}
, где:
{object} - сущность, например: box, backup;
{action} - действие над сущностью, например: add, delete.

В ответ будет получен JSON-объект в кодировке UTF-8 с полями data, error.
В случае успешного выполнения запроса поле data содержит результат выполенного запроса и код состояния сервера 200 ОК.

При возникновении ошибки поле error содержит код (error.code) и описание ошибки (error.description). Код состояния сервера в таком случае 400 Bad Request.

Для аутентификации обязательна отправка заголовков:

AUTH-LOGIN: {login}
AUTH-KEY: {key}

Логин и ключ можно получить в личном кабинете.

Типы запросов

Синхронные - получение результата в ответ на запрос

Асинхронные - получение id задания для проверки статуса выполнения методом status/show