Información general

La API de Datadog permite obtener datos dentro y fuera de Datadog. Utiliza URL orientadas a recursos y códigos de estado para indicar el éxito o el fracaso de las solicitudes y, luego, devuelve JSON de todas las solicitudes.

En este artículo, se explica cómo utilizar Postman para realizar llamadas de API a Datadog mostrando las acciones disponibles dentro de la API de Datadog y proporcionando una introducción muy clara sobre cómo se usa Postman con GET, POST, PUT y DELETE.

Requisitos previos

Ahora tienes:

• Una implementación activa de Datadog.
• Acceso a tus claves de API y de aplicación de Datadog.
• Conocimientos básicos de la estructura de la API y del formato JSON.
• Una cuenta Postman gratuita.

Configuración

Importar la colección de Datadog en Postman

Empieza iniciando sesión en Postman. Datadog recomienda descargar la aplicación Postman.

Esta colección funciona en Postman para la web o en tu aplicación Postman. Puede tardar varios segundos en cargarse.

Nota: Configura las variables de colección de la colección de API de Datadog con tus valores de API y clave de aplicación.

Configuración de la colección de Postman

Una vez importada la colección de Postman, en el panel izquierdo de Postman se estructuran por carpetas todas las llamadas a la API de Datadog disponibles.

Autenticación

Añade tu API de Datadog y claves de aplicación a las variables de colección para la autenticación.

Sigue estos pasos para configurar tu entorno:

1. Selecciona la colección de API de Datadog.

2. Haz clic en la pestaña Variables.

3. Añade tus valores válidos de API de Datadog y clave de aplicación al campo Current value (Valor actual) de las variables api_key y application_key, respectivamente.

4. Haz clic en Save (Guardar).

Cambiar el endpoint de la API

Si accedes a un sitio de Datadog distinto de https://api.datadoghq.com, deberás cambiar la colección de Postman para acceder a una URL de endpoint diferente.

Sigue estos pasos para usar el sitio seleccionado en la instancia ():

1. En la carpeta Datadog API Collection (Colección de API de Datadog) del panel izquierdo, haz clic en el menú de tres puntos y selecciona Edit (Editar).

2. En la pestaña Variables, anula la selección de la variable site con el valor datadoghq.com y selecciona site con el valor .

3. Haz clic en Update (Actualizar).

Trabajar con la colección

Una vez completada la configuración, ya puedes empezar a hacer llamadas a la API. En la carpeta Postman –> Datadog, hay subcarpetas para cada tipo de categoría de API del artículo Referencia a la API de Datadog. Expande las subcarpetas para ver los métodos HTTP y los nombres de las llamadas a la API.

Generador

Al hacer clic en una llamada a la API de la colección, esta se carga en el panel Builder (Generador) de la derecha. En este panel se puede enviar la llamada a la API y ver el estado devuelto, el tiempo de respuesta y el código de respuesta de la API.

Descripción

Al hacer clic en el nombre del endpoint, se muestra una descripción del endpoint y todos los parámetros necesarios y opcionales para ayudarte a crear tus solicitudes:

Parámetros

La pestaña Params muestra todos los parámetros y valores de la llamada a la API. Aquí puedes añadir los parámetros y valores que quieras. Consulta los argumentos disponibles en la sección correspondiente de la documentación de la API de Datadog.

Esta pestaña es una alternativa a la visualización de la estructura param1:value1&param2:value2 de la llamada a la API.

Notas:

• El ampersand (&) y los dos puntos (:) no son necesarios en la tabla Params. Postman los inserta por ti.
• Todos los parámetros siguen el formato: <PLACEHOLDER>. Deben reemplazarse antes de ejecutar una consulta.