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

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

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

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

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

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

Authorization: Token <device_api_token>

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

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

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

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

1. Перейдите в раздел API Access в Панели управления.

2. Нажмите Generate New Token.

3. В появившемся окне выберите тип токена:

   • Server — используется для большинства методов API (кроме методов Device API).

   • Device — используется только для методов Device API.

4. Введите имя для токена.

5. Нажмите Generate, чтобы создать токен.

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

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

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

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

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

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

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

• Изменить имя токена

• Скопировать значение токена

• Выбрать, к каким проектам токен имеет доступ, отмечая или снимая отметки в списке

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

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

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

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

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // вставьте ваш серверный токен сюда
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

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

Authorization: Token <device_api_token>

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