Получение доступа к ChatApp API

Получение доступа к ChatApp API

Для выполнения запросов к API, требуется передача accessToken в заголовке Authorization.

Получение токена доступа

Чтобы получить токен доступа, используйте метод tokens.make.

Потребуется указать данные из личного кабинета: email, password и appId.

В ответ вы получите пару токенов (accessToken и refreshToken):

  • accessToken - Действует 24 часа. Необходим для выполнения запросов к API.
  • accessTokenEndTime - Время (unix timestamp) окончания действия accessToken.
  • refreshToken - Действует 14 дней. Необходим для получения новой пары токенов (продления доступа).
  • refreshTokenEndTime - Время (unix timestamp) окончания действия refreshToken.

Полученные токены необходимо сохранить на стороне приложения для дальнейшей возможности выполнять запросы к API и продления доступа (получение новой пары токенов).

Продление токена доступа

Чтобы продлить доступ (получить новую пару токенов), используйте метод tokens.refresh.

В ответ вы получите свежую пару токенов.

Полученные токены необходимо сохранить на стороне приложения для дальнейшей возможности выполнять запросы к API и продления доступа (получение новой пары токенов).

Рекомендации по продлению токена доступа

Мы сталкивались со случаями, когда разработчики приложений "на всякий случай" перед каждым обращением к API сначала получали токен доступа через вызов tokens.make. Это неправильный сценарий, создающий лишнюю нагрузку. Тоже самое касается сценариев с автоматическим обновлением токенов раз в час, или раз в сутки - это лишнее.

Если вы сохраните пару токенов - accessToken и refreshToken - на стороне приложения, то вы просто делаете запрос к API, указав сохраненный accessToken (предположим, что вы, сохранив accessToken, не сохранили дату и время его окончания). Если токен уже не актуален, в ответ вы получите соответствующую ошибку:

{
    "success": false,
    "error": {
        "code": "ApiInvalidTokenError",
        "message": "Invalid Token"
    }
}

Вот в этот момент надо сделать запрос tokens.refresh с сохраненным ранее refreshToken для получения новых accessToken и refreshToken. Новую пару токенов сохранить на стороне приложения, а затем повторить свой запрос к API с новым accessToken.

Ограничения на получение токенов доступа

Получение новых токенов методом tokens.make ограничено.

Доступно 100 токенов в день для email-appId.


 

Помощь интеграторов