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