Обзор 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 toPushwoosh 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 toPushwoosh API обычно возвращает ответы в формате JSON.
Коды успешных операций и ошибок
Anchor link toКоды успешных операций
Anchor link toКогда ваш запрос к API обработан успешно, вы получите код успешной операции в составе ответа.
Код состояния HTTP | Сообщение о состоянии | Описание |
---|---|---|
200 | OK | Pushwoosh успешно обработал запрос |
Обратите внимание, что получение ответа HTTP 200 означает, что ваш запрос был понят и успешно обработан, но это не гарантирует успешности самого действия. Поэтому обязательно проверяйте наличие сообщений об ошибках или предупреждений (доступ запрещен, приложение не найдено, недействительный ключ API и т. д.), чтобы определить, было ли действие успешным.
Код состояния | Сообщение о состоянии |
---|---|
200 | Warnings: You have reached the subscriber limit. Push Message will be sent to 1 random device only |
200 | Warnings: You have exceeded the number of active devices allowed on your current subscription plan. |
210 | Access denied or application not found |
210 | Application not found |
210 | Application suspended |
210 | Account not found |
210 | Account has been suspended |
210 | Suspended account can not use device filtration |
210 | API token or application is not set |
210 | Please select at least one platform |
210 | Invalid API Token: Account not found |
210 | No application or group code given |
210 | API token or application or account is not set |
Коды ошибок
Anchor link toВ случае если ваш запрос неправильно отформатирован, возникли проблемы с его обработкой или любые другие ошибки, Pushwoosh отправит вам код ошибки, указывающий на характер проблемы. Это поможет вам эффективно диагностировать и устранить неполадку.
Код состояния HTTP | Сообщение о состоянии | Описание |
---|---|---|
400 | Неверный запрос | Запрос не может быть выполнен из-за синтаксической ошибки |
401 | Не авторизован | Аутентификация не пройдена или не была предоставлена |
403 | Token restrictions forbid this operation. | Ваш токен доступа не имеет необходимых разрешений для выполнения запрошенного действия. Чтобы это исправить, проверьте разрешения вашего токена доступа в панели управления Pushwoosh и при необходимости измените их в соответствии с требованиями для конкретной операции, которую вы хотите выполнить. |
404 | Ресурс не найден | Указывает, что запрошенный ресурс, например, приложение, не удалось найти или он не существует на сервере. |
500 | Внутренняя ошибка | Во время обработки запроса API на сервере произошла непредвиденная проблема или ошибка. |