Асинхронный API SpectrumData использует HTTP в качестве основного протокола и поддерживает POST и GET-запросы.
Параметры для POST-запросов необходимо передавать в JSON-объектах, в GET-запросах используются параметры строки запроса.
Ответ от API всегда возвращается в формате JSON.
При работе в асинхронном режиме ответом на запрос генерации отчёта является идентификатор созданного отчёта. Обратиться к сформированному отчёту можно по его идентификатору, используя отдельный эндпоинт.
Базовый URL:
https://b2b-api.spectrumdata.ru/b2b/api/v1/
Для аутентификации пользователя необходимо с каждым запросом передавать ключ доступа в заголовке Authorization
. Правила формирования и использования токена аутентификации
Если запрос обработан успешно, API вернёт HTTP-код 200
и тело ответа.
Если при обработке запроса возникает ошибка, API возвращает HTTP-код ошибки и её описание в теле ответа.
Для работы с API вы можете использовать Swagger UI.
Выполнять запросы через Swagger UI с использованием данных своей учётной записи можно в разделе user
. В таком режиме генерируются отчёты с реальными данными и происходит списание средств с баланса.