Nouvelles annonces sur les technologies sans serveur et réseau ainsi que sur le RUM (Real-User Monitoring) dévoilées à la conférence Dash ! Nouvelles annonces dévoilées à la conférence Dash !

Utiliser Postman avec les API Datadog

Présentation

L’API Datadog vous permet d’envoyer des données à Datadog et de recevoir des données de Datadog. Elle utilise des URL orientées ressources et des codes de statut afin d’indiquer la réussite ou l’échec des requêtes et renvoie un objet JSON à partir de toutes les requêtes.

Cet article explique comment utiliser Postman pour effectuer des appels d’API vers Datadog en vous montrant les actions disponibles au sein de l’API Datadog et vous donne une introduction de haut niveau de l’utilisation des méthodes GET, POST, PUT, et DELETE de Postman.

Prérequis

Vous avez :

Implémentation

Importer la collection Datadog

Une fois les prérequis établis :

  1. Téléchargez la collection Postman Datadog (modèles d’appel d’API préconfigurés). Dans Postman, une collection est un répertoire d’appels d’API organisés pour faciliter leur modification, enregistrement et réutilisation.

  2. Importez la collection Postman Datadog :

Vous disposez maintenant d’une collection Datadog contenant de nombreux exemples différents d’API.

Remarque : les appels d’API ne fonctionnent pas encore à cette étape. Continuez à lire pour configurer votre environnement Datadog-Postman.

Configuration de l’environnement Postman

Après l’importation de la collection Postman, une liste complète des appels d’API Datadog disponibles est arrangée par répertoire dans le volet de gauche de Postman. Dans les répertoires, les appels d’API ont des variables entrées pour datadog_site, datadog_api_key, et datadog_application_key :

Cela vous permet de configurer les environnements Postman et d’enregistrer votre site Datadog, ainsi que les clés d’application pour l’authentification. Si vous avez plusieurs organisations Datadog, définissez plusieurs environnements Postman pour effectuer des appels d’API vers différentes organisations sans modifier les appels d’API dans la collection Postman Datadog.

Suivez ces étapes pour configurer votre environnement :

  1. Cliquez sur l’icône de gestion des environnements en forme d’engrenage dans le coin supérieur droit de Postman.

  2. Cliquez sur Add pour entrer un nom d’environnement.

  3. Dans le tableau, ajoutez les variables datadog_api_key et datadog_application_key. Dans la colonne Current Value, entrez vos clés d’API et d’application Datadog réelles.

  4. Ajoutez la variable datadog_site. Dans la colonne Current Value, entrez com si vous êtes sur le site américain Datadog ou eu si vous êtes sur le site européen Datadog.

  5. Facultatif : si vous avez plusieurs organisations Datadog, répétez les étapes 1 à 4 pour chaque organisation.

Utilisation de la collection

Une fois la configuration terminée, vous êtes prêt(e) à effectuer des appels d’API. Dans le répertoire Postman -> Datadog, vous trouverez des sous-répertoires pour chaque type de catégorie d’API énuméré dans la référence de l’API Datadog. Développez les sous-répertoires pour afficher les méthodes HTTP et les noms des appels d’API.

Remarque : n’oubliez pas de définir votre environnement défini dans le coin supérieur droit de l’interface Postman :

Builder

Lorsque vous cliquez sur un appel d’API dans la collection, il s’affiche dans le volet Builder, à droite. Depuis ce volet, vous pouvez envoyer l’appel d’API et voir le statut retourné, le temps de réponse et le code de réponse d’API.

Description

Lorsque vous cliquez sur le nom d’un endpoint, une description du endpoint et de tous les paramètres obligatoires/facultatifs s’affiche pour vous aider à créer vos requêtes :

Params

L’onglet Params affiche tous les paramètres et toutes les valeurs actuellement sur l’appel d’API. Depuis cet onglet, vous pouvez ajouter des paramètres et des valeurs. Consultez les arguments disponibles dans la section correspondante de la documentation de l’API Datadog.

Cet onglet remplace l’affichage de la structure param1:value1&param2:value2 de l’appel d’API.

Remarques :

  • L’esperluette (&) et les deux-points (:) ne sont pas nécessaires dans le tableau de paramètres. Postman les ajoute pour vous.
  • Tous les placeholders respectent le format : <PLACEHOLDER> . Ils doivent être remplacés avant de lancer une requête.