Перейти к содержанию

Обзор Pushwoosh API

Pushwoosh API позволяет разработчикам взаимодействовать с платформой Pushwoosh.

Что можно делать с помощью Pushwoosh API?

Anchor link to

С помощью Pushwoosh API вы получаете доступ к обширной библиотеке из более чем 100 методов, которые позволяют вам:

  • Отправлять персонализированные push-уведомления
  • Создавать, импортировать, экспортировать и управлять пользовательскими сегментами для точного таргетинга
  • Использовать bulk API для пакетного управления пользователями/устройствами
  • Настраивать приложения
  • Отслеживать события пользователей и добавлять теги пользователям для улучшения таргетинга и персонализации
  • Создавать и управлять сущностями Pushwoosh, такими как пресеты, теги, события, приложения и т. д.
  • Запускать Customer Journeys в Pushwoosh через API
  • Получать подробную статистику по Customer Journeys и кампаниям push-уведомлений/email/SMS.
  • Реализовывать геофенсинг для отправки уведомлений на основе местоположения, когда пользователи входят в определенные географические зоны или покидают их
  • Бесшовно интегрировать сторонние сервисы с Pushwoosh

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

Аутентификация

Anchor link to

Pushwoosh API использует токены API для аутентификации запросов. Существует два типа токенов: серверные и устройств, каждый из которых используется для определенных областей действия API.

Каждая учетная запись Pushwoosh поставляется с токеном доступа API по умолчанию, созданным для демо-приложения Pushwoosh. Вы можете просматривать, создавать и управлять своими токенами API в панели управления Pushwoosh.

Ограничения по частоте запросов

Anchor link to

Ограничение по частоте запросов (rate limit) — это количество запросов, которое API может получить за определенный период. Хотя большинство запросов к API в Pushwoosh не ограничены, для запросов к API /createMessage установлено ограничение в 600 запросов в минуту для обеспечения качества обслуживания для всех пользователей.

Запросы

Anchor link to

Для всех запросов к API обязательно использование HTTPS, что обеспечивает безопасную передачу данных.

Ответы

Anchor link to

Pushwoosh API обычно возвращает ответы в формате JSON.

Коды успешных операций и ошибок

Anchor link to

Коды успешных операций

Anchor link to

Когда ваш запрос к API обработан успешно, вы получите код успешной операции в составе ответа.

Код состояния HTTP
Сообщение о состоянииОписание
200OKPushwoosh успешно обработал запрос

Обратите внимание, что получение ответа HTTP 200 означает, что ваш запрос был понят и успешно обработан, но это не гарантирует успешности самого действия. Поэтому обязательно проверяйте наличие сообщений об ошибках или предупреждений (доступ запрещен, приложение не найдено, недействительный ключ API и т. д.), чтобы определить, было ли действие успешным.

Код состояния
Сообщение о состоянии
200Warnings: You have reached the subscriber limit. Push Message will be sent to 1 random device only
200Warnings: You have exceeded the number of active devices allowed on your current subscription plan.
210Access denied or application not found
210Application not found
210Application suspended
210Account not found
210Account has been suspended
210Suspended account can not use device filtration
210API token or application is not set
210Please select at least one platform
210Invalid API Token: Account not found
210No application or group code given
210API token or application or account is not set

Коды ошибок

Anchor link to

В случае если ваш запрос неправильно отформатирован, возникли проблемы с его обработкой или любые другие ошибки, Pushwoosh отправит вам код ошибки, указывающий на характер проблемы. Это поможет вам эффективно диагностировать и устранить неполадку.

Код состояния HTTP
Сообщение о состоянииОписание
400Неверный запросЗапрос не может быть выполнен из-за синтаксической ошибки
401Не авторизованАутентификация не пройдена или не была предоставлена
403Token restrictions forbid this operation.Ваш токен доступа не имеет необходимых разрешений для выполнения запрошенного действия. Чтобы это исправить, проверьте разрешения вашего токена доступа в панели управления Pushwoosh и при необходимости измените их в соответствии с требованиями для конкретной операции, которую вы хотите выполнить.
404Ресурс не найденУказывает, что запрошенный ресурс, например, приложение, не удалось найти или он не существует на сервере.
500Внутренняя ошибкаВо время обработки запроса API на сервере произошла непредвиденная проблема или ошибка.