Примечание: Для выполнения запросов к API, требуется передача accessToken в заголовке Authorization, а для получения токена доступа, используйте метод tokens.make.
Для начала, вам необходимо будет указать данные из личного кабинета: email, password и appId.
Сделав запрос, в ответ вы получите токены: accessToken и refreshToken:
- accessToken нужен для выполнения запросов к API и действует 24 часа
- accessTokenEndTime - это время (unix timestamp) окончания действия accessToken.
- refreshToken необходим для получения новой пары токенов (продления доступа) и действует 14 дней.
- refreshTokenEndTime - это время (unix timestamp) окончания действия refreshToken.
Полученные токены необходимо сохранить на стороне приложения для дальнейшей возможности выполнять запросы к API и продления доступа.
Продление доступа
Чтобы продлить доступ и получить новую пару токенов, используйте метод tokens.refresh.
Полученные при такой процедуре токены, также необходимо сохранить на стороне приложения , чтобы иметь возможность повторно выполнять запросы к API и продлевать доступ.
Рекомендации по продлению токена доступа
Мы сталкивались со случаями, когда разработчики приложений «на всякий случай» перед каждым обращением к API, сначала получали токен доступа через вызов tokens.make. Это неправильный сценарий, создающий лишнюю нагрузку. Тоже самое касается сценариев с автоматическим обновлением токенов раз в час, или раз в сутки - это лишнее.
Ведь если вы сохраните вышеупомянутую пару токенов на стороне приложения, то вам просто нужно сделать запрос к API, указав сохраненный accessToken (например в случае когда вы, сохранив accessToken, не сохранили дату и время его окончания). Если токен уже не актуален, в ответ вы получите соответствующую ошибку:
{
"success": false,
"error": {
"code": "ApiInvalidTokenError",
"message": "Invalid Token"
}
}
Вот тут нам и понадобится сделать запрос tokens.refresh, с сохраненным ранее refreshToken, для получения новой пары токенов. Эту новую пару мы должны сохранить на стороне приложения, а после этого повторить свой запрос к API с новым accessToken.
Ограничения на получение токенов доступа
Стоит помнить, что получение новых токенов методом tokens.make ограничено. Для email-appId их количество лимитируется: 100 токенов в день .