Использование мультисайтового API токена в API запросах

Читать 3

Получение мультисайтового API токена

Для получения возможности получить и использовать мультисайтовый API токен необходимо подать запрос к аккаунт менеджеру или техподдержке. В запросе укажите почту пользователя Calltouch для которого надо активировать данный функционал. Мы активируем его со своей стороны и указанный юзер сможет получить мультисайтовый API токен в настройках профиля пользователя. После этого Вы сможете получить мультисайтовый API токен в настройках пользователя, во вкладке API:

image2023-6-14_16-0-34.png

Перейдя в указанную вкладку - вы увидите экран управления мультисайтовыми API токенами. Тут вы можете создать новый токен или скопировать существующий.

image2023-8-7_13-38-20.png

Использование мультисайтового API токена в API запросах

При использовании в API методах мультисайтового API токена:

1) Для обычных API методов, с передачей авторизационных данных в заголовках запроса.

Авторизация происходит по 2м заголовкам в запросе - API токену и ID сайта:

  • Access-Token: мультисайтовый API токен
  • SiteId: Id сайта

То есть, при использовании мультисайтового токена - авторизационные данные отправляются аналогично, как и при использовании обычного API токена.

2) Для обычных API методов, с передачей авторизационных данных в теле POST или GET запроса:

Авторизация происходит по 2 параметрам - API токену и ID сайта:

  • Мультисайтовый API токен передается в параметре clientApiId
  • ID сайта передается в URL запроса. Для API запросов, у которых передача ID сайта в URL запроса не предусмотрено - его надо передавать в отдельном параметре siteId.

То есть, при использовании мультисайтового токена - авторизационные данные отправляются аналогично, как и при использовании обычного API токена. Исключение составляют API методы, в которых при использовании обычного API токена передача ID сайта не предусмотрена, для таких методов надо просто добавить параметр siteId в тело запроса, передав в него ID сайта.