Настроить синхронизацию

/syncApi/setupSynchronization

POST

https://secured-openapi.tbank.ru/syncApi/setupSynchronization

Устанавливает токен, адрес и порт для обратного соединения с КНАП, а также включает синхронизацию для указанной организации. Вызывается КНАП при первоначальной настройке интеграции

Авторизация

Security

Bearer API Token

MTLS-сертификат

RPS

Ограничение — 5 запросов в секунду

Scopes

Интеграция с КНАП → Методы для работы с документами в Бухгалтерии

Запрос

Header parameters

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Request body schema application/json

Required

token

String

Requirements: <= 255 characters

Токен для аутентификации при обратных вызовах к КНАП

Required

url

String<uri>

Requirements: <= 512 characters

Базовый URL для вызовов к API КНАП

Required

port

Integer

Requirements: >= 1 and <= 65535

Порт для соединения с КНАП

Required

organizationGuid

String<uuid>

Идентификатор организации в КНАП

Required

organizationId

String

Requirements: <= 20 characters

Идентификатор организации в нашей системе

Ответ

200

Настройки успешно сохранены

400

Некорректный запрос

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка при обработке данных

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Loading...