Токен доступа API

Токен доступа API — это уникальный идентификатор, присваиваемый одному или нескольким проектам в вашей учетной записи. Он аутентифицирует вашу учетную запись для управления проектами через API, включая изменение учетной записи, отправку сообщений, редактирование проектов и т. д.

Типы токенов доступа API

Pushwoosh предоставляет два различных типа токенов доступа API: серверный (Server) и для устройств (Device).

Каждый тип токена действителен только для своей конкретной области применения API. Если используется неверный токен, произойдет ошибка аутентификации.

Серверный токен API

Серверный токен API используется со всеми методами API, за исключением тех, которые относятся к API устройств. Он должен быть включен в тело запроса в поле auth.

Токен API устройства

Токен API устройства используется исключительно с методами API устройств. Он должен быть включен в заголовки HTTP-запроса с использованием заголовка Authorization. Ниже приведен пример правильного формата заголовка:

Authorization: Token <device_api_token>

Замените <device_api_token> на фактическое значение вашего токена API устройства.

Создание и управление токенами доступа API

Вы можете просматривать, создавать и управлять своими токенами доступа API в разделе API Access Панели управления Pushwoosh. Чтобы получить к нему доступ, перейдите в Settings → API Access. Токен Pushwoosh Demo App

По умолчанию каждая учетная запись включает токен под названием Pushwoosh Demo App, который настроен как серверный токен.

Создание нового токена доступа API

Чтобы создать новый токен доступа API:

Перейдите в раздел API Access в Панели управления.
Нажмите Generate New Token.
В появившемся окне выберите тип токена:
- Серверный, используемый для большинства методов API (за исключением методов API устройств).
- Для устройств, используемый только для методов API устройств.
Введите имя для токена.
Нажмите Generate, чтобы создать токен.

Создание нового токена

Важно: Убедитесь, что вы предоставили токену доступ к нужному приложению в Панели управления Pushwoosh. Подробнее

Новый токен появится в списке API Access. Оттуда вы можете скопировать его значение для использования в запросах API или управлять его правами доступа по мере необходимости.

Управление токеном

Чтобы управлять существующим токеном API, нажмите на меню с тремя точками (⋮) рядом с записью токена в разделе API Access.

Управление токеном

Доступны следующие опции:

Предоставить доступ ко всем проектам

Предоставляет токену доступ ко всем проектам в вашей учетной записи. Это позволяет ему полноценно использовать API во всех проектах.

Отозвать доступ ко всем проектам

Удаляет доступ токена ко всем проектам в вашей учетной записи. Токен больше не сможет использовать API, пока доступ не будет предоставлен снова.

Редактировать токен

Открывает экран Edit API Token Permissions, где вы можете:

Изменить имя токена
Скопировать значение токена
Выбрать, к каким проектам токен может получить доступ, выбирая или отменяя их выбор в списке

Управление токеном

После внесения изменений нажмите Save, чтобы применить их.

Удалить токен

Безвозвратно удаляет токен из вашей учетной записи.

Авторизация запросов API

Для авторизации запросов API используйте правильный тип токена доступа API в зависимости от типа вызываемого метода API:

Для методов серверного API

Включите токен в поле “auth” тела запроса:

Пример:

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // paste your server token here
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

Для методов API устройства

Используйте токен устройства. Включите его в заголовок HTTP-запроса в следующем формате:

Authorization: Token <device_api_token>

Замените <device_api_token> на фактическое значение вашего токена.