Обзор API Pushwoosh

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

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

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

Отправлять персонализированные Push-уведомления
Создавать, импортировать, экспортировать и управлять сегментами пользователей для точного таргетинга
Использовать массовые API для управления пользователями/устройствами в пакетах
Настраивать приложения
Отслеживать события пользователей и добавлять теги к пользователям для улучшения таргетинга и персонализации
Создавать и управлять сущностями Pushwoosh, такими как пресеты, теги, события, приложения и т.д.
Запускать Customer Journeys Pushwoosh через API
Получать исчерпывающую статистику по Customer Journeys и Push/Email/SMS кампаниям.
Внедрять геофенсинг для отправки уведомлений на основе местоположения, когда пользователи входят или выходят из определенных географических областей
Бесшовно интегрировать 3rd party services с Pushwoosh

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

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

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

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

Узнать больше

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

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

Запросы

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

Ответы

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

Коды успеха и ошибок

Коды успеха

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

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

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

Код состояния	Сообщение о состоянии
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

Коды ошибок

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

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