Обзор API Wavesend
API Wavesend позволяет разработчикам взаимодействовать с платформой Wavesend.
Что можно делать с помощью API Wavesend?
Section titled “Что можно делать с помощью API Wavesend?”С помощью API Wavesend вы получаете доступ к обширной библиотеке из более чем 100 методов, позволяющих:
- Отправлять персонализированные push-уведомления
- Создавать, импортировать, экспортировать и управлять user segments для точного таргетинга
- Использовать API для массовых операций для управления пользователями/устройствами в пакетном режиме
- Настраивать applications
- Отслеживать user events и добавлять tags пользователям для улучшения таргетинга и персонализации
- Создавать и управлять сущностями Wavesend, такими как presets, tags, events, applications и т.д.
- Запускать Customer Journeys Wavesend через API
- Получать подробную статистику по Customer Journeys и кампаниям Push/Email/SMS.
- Реализовать геозонирование для отправки уведомлений на основе местоположения, когда пользователи входят в определенные географические зоны или выходят из них
- Бесшовно интегрировать сторонние сервисы с Wavesend
Чтобы изучить полный спектр доступных методов и широкие возможности API Wavesend, обратитесь к справочнику методов API.
Аутентификация
Section titled “Аутентификация”API Wavesend использует API tokens для аутентификации запросов. Существует два типа токенов: Server и Device, каждый из которых используется для определенных областей действия API.
В каждой учетной записи Wavesend есть API Access Token по умолчанию, созданный для Demo App Wavesend. Вы можете просматривать, создавать и управлять вашими API tokens в Control Panel Wavesend.
Ограничения скорости (Rate limits)
Section titled “Ограничения скорости (Rate limits)”Ограничение скорости (rate limit) — это количество запросов, которое API может получить за определенный период времени. Хотя большинство запросов к API Wavesend не ограничены, количество запросов к API /createMessage ограничено 600 в минуту для обеспечения качества обслуживания всех пользователей.
Запросы
Section titled “Запросы”Для всех запросов к API обязательно использование HTTPS, что обеспечивает безопасную передачу данных.
Ответы
Section titled “Ответы”API Wavesend обычно возвращает ответы в формате JSON.
Коды успешного выполнения и коды ошибок
Section titled “Коды успешного выполнения и коды ошибок”Коды успешного выполнения
Section titled “Коды успешного выполнения”Когда ваш запрос к API успешно обработан, вы получите код успешного выполнения в составе ответа.
| Код состояния HTTP | Сообщение о состоянии | Описание |
|---|---|---|
| 200 | OK | Wavesend успешно обработал запрос |
Обратите внимание, что получение ответа с кодом 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 |
Коды ошибок
Section titled “Коды ошибок”Если ваш запрос неправильно отформатирован, возникли проблемы с его обработкой или любые другие ошибки, Wavesend отправит вам код ошибки, указывающий на характер проблемы, что поможет вам эффективно устранить ее.
| Код состояния HTTP | Сообщение о состоянии | Описание |
|---|---|---|
| 400 | Неверный запрос | Запрос не может быть выполнен из-за синтаксической ошибки |
| 401 | Не авторизован | Аутентификация не удалась или не была предоставлена |
| 403 | Token restrictions forbid this operation. | Ваш токен доступа не имеет необходимых разрешений для выполнения запрошенного действия. Чтобы это исправить, просмотрите разрешения вашего токена доступа в Control Panel Wavesend и при необходимости измените их в соответствии с требованиями для конкретной операции, которую вы хотите выполнить. |
| 404 | Ресурс не найден | Указывает, что запрошенный ресурс, например, app, не может быть найден или не существует на сервере. |
| 500 | Внутренняя ошибка | При обработке запроса API на сервере возникла непредвиденная проблема или ошибка. |