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 :

Configuration

Importer la collection Datadog dans Postman

Commencez par vous connecter à Postman. Datadog recommande de télécharger l’application Postman.



Cette collection fonctionne dans l’interface Web ou l’application de Postman. Son chargement peut prendre quelques secondes.

Configuration de l’environnement Postman

Après avoir importé la collection Postman, la liste complète des appels d’API Datadog disponibles s’affiche. Elle est arrangée par dossier dans le volet de gauche de Postman.

Authentification

La collection comprend un environnement Postman du nom de Datadog Authentication, au sein duquel vous pouvez ajouter votre clé d’API Datadog et des clés d’application pour l’authentification.

Suivez ces étapes pour configurer votre environnement :

  1. Cliquez sur la liste déroulante Environments en haut à droite de Postman.

  2. Sélectionnez Datadog Authentication.

  3. Modifiez l’environnement Datadog Authentication en ajoutant votre clé d’API Datadog en tant que valeur initiale et actuelle de la variable api_key. Ajoutez également votre clé d’application Datadog en tant que valeur initiale et actuelle de la variable application_key.

Changer l’endpoint de l’API

Si vous accédez à un autre site Datadog que https://api.datadoghq.com, vous devez modifier la collection Postman afin qu’elle utilise une autre URL d’endpoint.

Suivez les étapes ci-dessous pour modifier l’instance afin de spécifier votre site, à savoir () :

  1. Dans le volet gauche du répertoire de collection d’API Datadog, cliquez sur le menu représentant trois points, puis sélectionnez Edit.

    Afficher plus d'actions
  2. Dans l’onglet Variables, décochez la variable site avec la valeur datadoghq.com et cochez la variable site avec la valeur .

  3. Cliquez sur Update.

Utilisation de la collection

Une fois la configuration terminée, vous pouvez à présent 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ée dans la section relative aux API de Datadog. Développez les sous-répertoires pour afficher les méthodes HTTP et les noms des appels d’API.

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 consulter le statut renvoyé, le délai de réponse et le code de la réponse d’API.

réponse_api_postman

Description

Lorsque vous cliquez sur le nom d’un endpoint, une description de l’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 inclus dans l’appel d’API. Vous pouvez ajouter des paramètres et des valeurs depuis cet onglet. Consultez les arguments disponibles dans la section correspondante de la documentation sur les API Datadog.

paramètre_postman

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

Remarques :

  • Il n’est pas nécessaire d’ajouter les esperluettes (&) et les deux-points (:) dans le tableau des paramètres. Postman les insère automatiquement.
  • Tous les placeholders respectent le format <PLACEHOLDER>. Vous devez les remplacer avant de pouvoir lancer une requête.