Identifiants clés de l'API
Cet article répertorie les identifiants essentiels utilisés dans les requêtes de l’API Pushwoosh. Ces identifiants sont nécessaires pour l’authentification, la création de messages, le ciblage, la segmentation, le suivi et la gestion des utilisateurs dans vos applications.
Identifiants généraux
Anchor link toCode d’application
Anchor link toUn identifiant unique attribué à chaque application dans votre compte Pushwoosh. Il est requis dans la plupart des appels API pour spécifier l’application cible.
Où le trouver
Panneau de contrôle Pushwoosh → Sous le nom de l’application.
Jeton d’accès à l’API
Anchor link toUn jeton unique attribué à un compte Pushwoosh, utilisé pour authentifier les requêtes API. Il permet d’accéder à la gestion des projets, à l’envoi de messages, à la modification des paramètres et à la récupération des données. Chaque compte dispose d’au moins un jeton créé par défaut. En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Accès API.
Identifiants d’appareil
Anchor link toID matériel (HWID)
Anchor link toUn identifiant unique attribué à un appareil par le SDK Pushwoosh. Défini automatiquement par le SDK ou transmis lors de l’enregistrement de l’appareil. En savoir plus
Où le trouver
-
Dans les journaux de l’appareil. En savoir plus
-
Dans User Explorer lors de la recherche par ID utilisateur
-
Dans le fichier CSV téléchargé depuis la liste des segments
Jeton push
Anchor link toUn jeton émis par les fournisseurs de plateforme qui identifie une paire application-appareil pour la livraison des notifications push. Collecté automatiquement par le SDK lorsque les autorisations push sont accordées. En savoir plus
Où le trouver
-
Dans les journaux de l’appareil. En savoir plus
-
Dans User Explorer, entrez le HWID dans le champ de recherche pour trouver l’appareil associé, puis ouvrez les détails de l’appareil pour voir le jeton push.
Type d’appareil
Anchor link toIndique la plateforme de l’appareil cible à l’aide d’un code numérique. Défini automatiquement par le SDK.
Valeurs prises en charge :
1 – iOS3 – Android7 – macOS8 – Windows9 – Amazon10 – Safari11 – Chrome12 – Firefox13 – Internet Explorer14 – Email16 – Baidu Android17 – Huawei18 – SMS20 – Web21 – WhatsApp22 – Line23 – Kakao Talk24 – Telegram25 – Apple Wallet26 – Google Wallet27 – ViberIdentifiants utilisateur
Anchor link toID utilisateur
Anchor link toUn identifiant personnalisé attribué à un utilisateur, permettant un ciblage multi-appareils et personnalisé. En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Audience → User Explorer
Identifiants de messagerie
Anchor link toCode de message
Anchor link toUn identifiant unique attribué à chaque message lors de sa création. Il suit un format spécifique : XXXX-XXXXXXXX-XXXXXXXX.
Ce code est essentiel pour :
- Suivre l’état et la livraison d’un message spécifique
- Annuler (ou supprimer) un message précédemment envoyé
- Obtenir les statistiques du message
Où le trouver
- Panneau de contrôle Pushwoosh : Naviguez vers Campagnes → Messages uniques, puis ouvrez les propriétés du message souhaité. Le code du message y sera affiché.
- Réponse de l’API
/createMessage: Lors de la création d’un nouveau message via l’API, le code du message est inclus dans la réponse.
ID de requête
Anchor link toMet en corrélation un message avec la requête HTTP qui l’a créé, vous permettant de tracer un envoi unique de bout en bout — de l’appel HTTP à la couche de routage de Pushwoosh jusqu’au message résultant.
Présent sur tout message créé par un appel HTTP à /createMessage ou à l’API de messagerie v2, y compris les messages envoyés depuis le Panneau de contrôle. Les messages créés par des Journeys, des envois cron ou d’autres déclencheurs internes non-HTTP n’ont pas d’ID de requête.
Définir votre propre valeur
Passez un en-tête X-Request-ID avec la requête. Si la valeur a une longueur de 8 à 128 caractères et ne contient que des lettres latines, des chiffres, des points, des tirets bas et des traits d’union, Pushwoosh la réutilise ; sinon — ou si l’en-tête est omis — Pushwoosh en génère un pour vous. Une valeur invalide est remplacée silencieusement, de sorte que la requête n’échoue jamais à cause de cela. L’unicité n’est pas appliquée, utilisez donc une valeur qui est réellement unique par requête si vous vous y fiez pour le traçage.
Où le trouver
Panneau de contrôle Pushwoosh → ouvrez un message → Détails du message → Afficher toutes les propriétés → Paramètres du message → ID de requête (avec un bouton de copie).
Exemple : a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d
Code in-app
Anchor link toUn code unique qui identifie une campagne in-app instantanée. Où le trouver
Panneau de contrôle Pushwoosh → Campagnes → In-apps instantanés. Dans la liste, le code est affiché sous le nom de la campagne.
Exemple : AAAAA-BBBBB
Identifiants de contenu
Anchor link toCode de préréglage
Anchor link toUn identifiant pour un préréglage de message enregistré (par exemple, push ou SMS). En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Contenu → Préréglages.
Vous pouvez trouver le code de préréglage à deux endroits :
-
Dans la vue en liste, affiché sous le nom du préréglage.
-
Dans l’URL lors de l’édition ou de la création d’un préréglage (c’est la dernière partie de l’URL).
Exemple :
URL : https://app.pushwoosh.com/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB
Code de préréglage : AAAAA-BBBBB
Code de rich media
Anchor link toIdentifiant pour un modèle de message in-app. En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Contenu → Rich media.
Exemple :
URL : https://app.pushwoosh.com/applications/XXXXX-XXXXX/rich-media/AAAAA-BBBBB/statistics
Code de rich media : AAAAA-BBBBB
Code de contenu d’e-mail
Anchor link toLe code de contenu d’e-mail est un identifiant unique pour le contenu d’e-mail enregistré. En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Contenu → Contenu d’e-mail.
Le code est la dernière partie de l’URL.
Exemple :
URL : https://app.pushwoosh.com/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB
Code de contenu d’e-mail : AAAAA-BBBBB
Identifiants de campagne
Anchor link toCode de campagne
Anchor link toUn identifiant unique utilisé pour référencer une campagne spécifique pour le suivi et l’analyse.
Où le trouver
Le code de campagne apparaît dans l’URL lors de la consultation des statistiques liées à la campagne dans le Panneau de contrôle Pushwoosh. Pour le localiser, allez dans Statistiques → Statistiques agrégées, cliquez sur la campagne souhaitée et copiez le code qui se trouve à la fin de l’URL.
Exemple :
URL : https://app.pushwoosh.com/applications/XXXXX-XXXXX/statistics/aggregated-message?campaignCode=YYYYY-YYYYY
Code de campagne : YYYYY-YYYYY
ID de Journey
Anchor link toUn identifiant unique utilisé pour associer des messages à des campagnes marketing spécifiques pour le suivi et l’analyse des performances.
Où le trouver
- Dans l’URL du canevas de la campagne dans le Panneau de contrôle Pushwoosh.
- Sélectionnez un point sur le canevas et appuyez sur Ctrl+I (Cmd+I) — cela copie
<UUID de journey>/<UUID de point>dans le presse-papiers ; l’ID de Journey est la partie avant la barre oblique.
Exemple :
URL : https://app.pushwoosh.com/journeys/XXXXX-XXXXX/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
ID de Journey : aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
Identifiants de segmentation et de ciblage
Anchor link toNom du segment / filtre
Anchor link toLe nom d’un segment d’utilisateurs prédéfini créé dans Pushwoosh pour le ciblage d’audience. En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Segments.
Code de segment / filtre
Anchor link toUn code unique au format XXXXX-XXXXX qui identifie un segment (également appelé filtre) dans Pushwoosh. Ce code est utilisé dans les appels API, la logique d’automatisation et les règles de segmentation dynamique.
Où le trouver
-
Via la méthode API
/listFilters. -
Dans la barre d’adresse lors de la visualisation d’un segment dans le Panneau de contrôle Pushwoosh :
Exemple :
URL : https://app.pushwoosh.com/applications/XXXXX-XXXXX/segments/XXXE9-XXX49/detail
Code de segment : XXXE9-XXX49
Un attribut personnalisé attribué aux utilisateurs ou aux appareils. Utilisé pour la segmentation dynamique et la personnalisation. En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Tags ou via l’API /getTags.
Identifiants d’événement
Anchor link toNom de l’événement
Anchor link toLe nom d’un événement suivi (par exemple, purchase, login, subscription). Utilisé pour déclencher des flux de travail automatisés ou pour l’analyse. En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Audience → Événements.
Identifiants de géolocalisation
Anchor link toID de Geozone
Anchor link toIdentifie une zone géorepérée utilisée pour déclencher des notifications basées sur la localisation. En savoir plus
Où le trouver
Panneau de contrôle Pushwoosh → Geozones.