Postman et demandes d’exemples

Braze vous permet de générer des exemples de requêtes API pour tous nos endpoints grâce à notre collection Postman. Cet article de référence couvre la collection Braze Postman, ce qu’elle est, comment la configurer et l’utiliser, ainsi que la façon de modifier et d’envoyer des requêtes.

Qu’est-ce que Postman ?

Postman est un outil d’édition visuelle gratuit permettant de créer et de tester des requêtes API. Par rapport à d’autres méthodes (par exemple, l’utilisation de cURL), Postman vous permet de modifier les requêtes API, d’afficher les informations d’en-tête, et bien plus encore. Vous pouvez enregistrer des collections (bibliothèques d’exemples de requêtes API préétablies). Pour accélérer la configuration avec notre REST API, nous fournissons une collection avec des exemples préétablis pour tous les endpoints.

Consultez ou téléchargez notre collection Postman en cliquant sur Run in Postman dans notre documentation Postman pour commencer.

Utilisation de la collection Braze Postman

Si vous disposez d’un compte Postman (vous pouvez télécharger les versions macOS, Windows et Linux depuis le site web de Postman), vous pouvez ouvrir notre documentation Postman dans votre propre application Postman en cliquant sur le bouton orange Run in Postman. Vous pouvez ensuite créer un environnement, ou utiliser notre environnement REST API de Braze comme modèle, et modifier les requêtes POST et GET disponibles pour répondre à vos propres besoins.

Configuration de votre environnement Postman

La collection Braze Postman utilise une variable de modèle, {{instance_url}}, pour remplacer l’URL de REST API de votre instance Braze dans les requêtes prédéfinies, et la variable {{api_key}} pour votre clé API. Au lieu de devoir modifier manuellement toutes les requêtes de la collection, vous pouvez configurer cette variable dans votre environnement Postman. Vous pouvez sélectionner notre environnement modèle (Braze REST API Environment Template) dans la liste déroulante, puis remplacer les valeurs des variables par les vôtres, ou créer votre propre environnement.

Pour créer votre propre environnement, procédez comme suit :

1. Dans l’onglet Workspaces, sélectionnez Environments.
2. Cliquez sur le bouton + plus pour créer un nouvel environnement.
3. Donnez un nom à cet environnement (par exemple, « Braze API Requests ») et ajoutez des clés pour instance_url et api_key avec des valeurs correspondant à votre instance Braze et à votre clé REST API de Braze.
4. Cliquez sur Save.

Remarque

Dans les corps de requête POST, la api_key doit être encadrée par des guillemets : "MY-API-KEY-EXAMPLE". Dans les URL GET, elle ne doit pas l’être. Nous avons déjà fourni ce formatage pour les corps de requête POST, les URL GET et le modèle d’environnement pour YOUR-API-KEY-HERE dans cette documentation.

Utiliser les requêtes prédéfinies de la collection

Après avoir configuré votre environnement, vous pouvez utiliser l’une des requêtes prédéfinies de la collection comme modèle pour créer de nouvelles requêtes API. Pour commencer à utiliser l’une des requêtes prédéfinies, cliquez dessus dans le menu Collections de Postman. Cela ouvrira la requête sous forme de nouvel onglet dans la fenêtre principale de l’application Postman.

En général, il existe deux types de requêtes que les endpoints API de Braze acceptent : GET et POST. Selon la méthode HTTP utilisée par l’endpoint, vous devrez modifier la requête prédéfinie différemment.

Modifier une requête POST

Lorsque vous modifiez une requête POST, ouvrez la requête et accédez à la section Body dans l’éditeur de requête. Pour une meilleure lisibilité, sélectionnez le bouton radio raw pour formater le corps de la requête JSON.

Modifier une requête GET

Lorsque vous modifiez une requête GET, modifiez les paramètres transmis dans l’URL de la requête. Pour ce faire, sélectionnez l’onglet Params et modifiez les paires clé-valeur dans les champs qui apparaissent.

Envoyer votre requête

Lorsque votre requête API est prête, cliquez sur Send. La requête est envoyée et les données de réponse s’affichent dans une section sous l’éditeur de requête. À partir de là, vous pouvez consulter les données brutes renvoyées par l’API de Braze, voir le code de réponse HTTP, vérifier le temps de traitement de la requête et afficher les informations d’en-tête.