Начало интеграции
Коллекция запросов
У API-документации есть коллекция запросов с примерами.
Авторизация
Это API использует авторизацию bearer authentication, используя ключ API для вашего проекта.
Ваш заголовок авторизации должен выглядеть примерно так:
--header 'Authorization: Bearer YWhhbWwsdG9uQGFwaWdlZS5jb206bClwYXNzdzByZAo'
API-ключ создаётся в вашем аккаунте. Подробнее
Идентификация пользователей
В рамках API интеграции вы можете как самостоятельно назначать ID для конечных пользователей и сессий, так и использовать идентификаторы, выданные платформой.
-
Если идентификатор пользователя хранится на вашей стороне:
- Передайте
user.idиsession.customв запросе. - В качестве ID можно использовать внутренние идентификаторы пользователя и сессии. Для объединения профиля между каналами дополнительно отправляйте события
login-v1илиsignup-v1с хешированным идентификатором.
- Передайте
-
Если идентификатор пользователя хранится на стороне платформы:
- В первом запросе
/ssapi/chooseне передавайтеuserиsession. - В первом запросе
/ssapi/eventпередайте"user": {}и"session": {}. - Сохраните
user.slidиsession.sl, возвращённые в ответе. - Передавайте их с последующими запросами.
- В первом запросе
В случае гибридной интеграции возможно использовать choose-запрос с пустым селектором для получения актуальных значений user.slid и session.sl