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 ?

Avec l’API Pushwoosh, vous avez accès à 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 pour gérer les utilisateurs/appareils par lots
Configurer des applications
Suivre les événements des utilisateurs 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 des préréglages, des tags, des événements, des 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/E-mail/SMS.
Mettre en œuvre le géorepérage 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

L’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 jeton d’accès API par défaut créé pour l’application de démonstration Pushwoosh. Vous pouvez afficher, créer et gérer vos jetons d’API dans le Control Panel de Pushwoosh.

Limites de débit

Une limite de débit 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 /createMessage et les requêtes équivalentes de l’API de messagerie v2 Notify sont plafonnées à 600 par minute pour garantir la qualité du service pour tous les utilisateurs.

Requêtes

HTTPS est obligatoire pour toutes les requêtes API, garantissant un transfert de données sécurisé.

Réponses

L’API Pushwoosh renvoie généralement des réponses au format JSON.

Codes de succès et d’erreur

Codes de succès

Lorsque 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 recevez 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 le succès de l’action. Assurez-vous donc de vérifier les messages d’erreur ou d’avertissement (accès refusé, application non trouvée, clé API invalide, etc.) pour déterminer le succès de l’action.

Code de statut	Message de statut
200	Avertissements : Vous avez atteint la limite d’abonnés. Le message push ne sera envoyé qu’à 1 appareil aléatoire
200	Avertissements : Vous avez dépassé le nombre d’appareils actifs autorisés dans votre plan d’abonnement actuel.
210	Accès refusé ou application non trouvée
210	Application non trouvée
210	Application suspendue
210	Compte non trouvé
210	Le compte a été suspendu
210	Un compte suspendu ne peut pas utiliser le filtrage des appareils
210	Le jeton d’API ou l’application n’est pas défini
210	Veuillez sélectionner au moins une plateforme
210	Jeton d’API invalide : Compte non trouvé
210	Aucun code d’application ou de groupe fourni
210	Le jeton d’API, l’application ou le compte n’est pas défini

Codes d’erreur

Si votre requête n’est pas correctement formatée, rencontre des problèmes de traitement ou toute autre erreur, Pushwoosh vous enverra un code d’erreur indiquant la nature du problème, vous aidant à le diagnostiquer et à le résoudre 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 résoudre ce problème, examinez les autorisations de votre jeton d’accès dans le panneau de contrôle 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 s’est produit(e) sur le serveur lors du traitement de la requête API.