Synchra.24
menu_bookҚұжаттама
Практические материалы по запуску и развитию

Здесь собраны инструкции по запуску, разработке внутренних сценариев и встраиванию собственных инструментов в рабочий контур компании.

folderИнтеграция және API

Компания белгісін алу

Таңдалған компаниямен біріктіру үшін Open API таңбалауышы арқылы провайдер таңбалауышын қалай алуға болады.

Аударма әзірге қолжетімсіз. Түпнұсқа көрсетілді.

Для обмена данными через Open API нужны два токена:

  • Open API token подтверждает доступ вашей интеграции;
  • provider token указывает компанию, с данными которой выполняется запрос.

Используйте отдельный токен интеграции, созданный через интерфейс Synchra24. Не копируйте токены входа пользователя из браузера или мобильного приложения.

Что подготовить

  1. Создайте токен Open API для нужной компании.
  2. Уточните идентификатор этой компании — provider_id. Его можно получить из интерфейса компании, например из адреса открытого раздела веб-версии.
  3. Получите токен компании запросом ниже.

Запрос токена компании

GET /api/v1/providers/user/params/{provider_id}
X-OpenAPI-Token: <OPEN_API_TOKEN>

Вместо {provider_id} укажите идентификатор компании, для которой создан токен интеграции.

Пример:

curl --request GET \
  --url https://getway.synchra24.com/api/v1/providers/user/params/123 \
  --header 'X-OpenAPI-Token: <OPEN_API_TOKEN>'

В ответе возьмите значение result.token. Это токен компании для следующих запросов.

Следующие запросы

Передавайте оба заголовка:

X-OpenAPI-Token: <OPEN_API_TOKEN>
X-Provider-Token: <PROVIDER_TOKEN>
Content-Type: application/json

Для работы с другой компанией нужны токены, выданные для неё. Нельзя подставить чужой идентификатор компании и получить доступ по токену своей интеграции.

Ошибки и безопасность

Если запрос отклонён, проверьте правильность идентификатора компании, срок действия токена Open API, подписку и права сотрудника, от имени которого создана интеграция.

Храните токены на стороне своей интеграции и не публикуйте их в открытом коде, переписке или снимках экрана. Если токен Open API раскрыт, отзовите его в настройках компании и создайте новый.

Доступные методы и правила авторизации приведены в Open API.