API Access token

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

Типы API Access token

Wavesend предоставляет два типа API Access token: Server и Device.

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

Server API token

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

Device API token

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

Authorization: Token <device_api_token>

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

Создание и управление API Access token

Вы можете просматривать, создавать и управлять своими API Access token в разделе API Access в Wavesend Control Panel. Чтобы получить к нему доступ, перейдите в Settings → API Access.

Токен Wavesend Demo App

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

Создание нового API Access token

Чтобы создать новый API Access token:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Для методов Server API

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

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

Для методов Device API

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

Authorization: Token <device_api_token>

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