Aperçu de l'API Pushwoosh
L’API Pushwoosh permet aux développeurs d’interagir avec la plateforme Pushwoosh.
Que pouvez-vous faire avec l’API Pushwoosh ?
Anchor link toAvec l’API Pushwoosh, vous accédez à une bibliothèque complète de plus de 100 méthodes vous permettant de :
- Envoyer des notifications push personnalisées
- Créer, importer, exporter et gérer des segments d’utilisateurs pour un ciblage précis
- Utiliser les API de masse (bulk) pour gérer les utilisateurs/appareils par lots
- Configurer des applications
- Suivre les événements utilisateur et ajouter des tags aux utilisateurs pour améliorer le ciblage et la personnalisation
- Créer et gérer des entités Pushwoosh telles que les Presets, les tags, les événements, les applications, etc.
- Démarrer des Customer Journeys Pushwoosh via l’API
- Récupérer des statistiques complètes sur les Customer Journeys et les campagnes Push/Email/SMS.
- Mettre en œuvre le geofencing pour envoyer des notifications basées sur la localisation lorsque les utilisateurs entrent ou sortent de zones géographiques spécifiques
- Intégrer de manière transparente des services tiers avec Pushwoosh
Pour explorer la gamme complète des méthodes disponibles et découvrir les vastes capacités de l’API Pushwoosh, veuillez vous référer à l’index de référence des méthodes de l’API.
Authentification
Anchor link toL’API Pushwoosh utilise des jetons d’API pour authentifier les requêtes. Il existe deux types de jetons : Serveur et Appareil, chacun utilisé pour des portées d’API spécifiques.
Chaque compte Pushwoosh est fourni avec un API Access Token par défaut créé pour la Demo App Pushwoosh. Vous pouvez afficher, créer et gérer vos jetons d’API dans le Control Panel de Pushwoosh.
Limites de débit
Anchor link toUne limite de débit (rate limit) est le nombre de requêtes que l’API peut recevoir dans une période donnée. Bien que la plupart des requêtes API dans Pushwoosh ne soient pas limitées, les requêtes API /createMessage
sont plafonnées à 600 par minute pour garantir la qualité du service pour tous les utilisateurs.
Requêtes
Anchor link toLe protocole HTTPS est obligatoire pour toutes les requêtes API, garantissant un transfert de données sécurisé.
Réponses
Anchor link toL’API Pushwoosh renvoie généralement des réponses au format JSON.
Codes de succès et d’erreur
Anchor link toCodes de succès
Anchor link toLorsque votre requête API est traitée avec succès, vous recevrez un code de succès dans la réponse.
Code de statut HTTP | Message de statut | Description |
---|---|---|
200 | OK | Pushwoosh a traité la requête avec succès |
Veuillez noter que lorsque vous obtenez une réponse HTTP 200, cela signifie que votre requête a été comprise et traitée avec succès, mais cela ne garantit pas la réussite de l’action. Assurez-vous donc de vérifier les messages d’erreur ou d’avertissement (accès refusé, application non trouvée, clé d’API invalide, etc.) pour déterminer le succès de l’action.
Code de statut | Message de statut |
---|---|
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 |
Codes d’erreur
Anchor link toSi votre requête n’est pas correctement formatée, rencontre des problèmes de traitement ou subit toute autre erreur, Pushwoosh vous enverra un code d’erreur indiquant la nature du problème, vous aidant à diagnostiquer et à résoudre le problème efficacement.
Code de statut HTTP | Message de statut | Description |
---|---|---|
400 | Requête incorrecte | La requête ne peut pas être traitée en raison d’une syntaxe incorrecte |
401 | Non autorisé | L’authentification a échoué ou n’a pas été fournie |
403 | Les restrictions du jeton interdisent cette opération. | Votre jeton d’accès ne dispose pas des autorisations nécessaires pour effectuer l’action demandée. Pour corriger cela, examinez les autorisations de votre jeton d’accès dans le Control Panel de Pushwoosh et ajustez-les si nécessaire pour correspondre aux exigences de l’opération spécifique que vous souhaitez effectuer. |
404 | Ressource non trouvée | Indique que la ressource demandée, telle qu’une application, n’a pas pu être localisée ou n’existe pas sur le serveur. |
500 | Erreur interne | Un problème ou une erreur inattendue est survenu(e) sur le serveur lors du traitement de la requête API. |