Crear una integración de API
Esta página guía a los socios tecnológicos en la creación de una integración de API en Datadog.
Integraciones de API
Utiliza endpoints de API Datadog para enriquecer la experiencia del cliente, enviando datos desde tu backend y extrayendo datos de la cuenta Datadog de un usuario. Los socios tecnológicos escriben y alojan su código dentro de su entorno.
Las integraciones de API son ideales para los socios tecnológicos que se basan en SaaS y tienen una plataforma existente que autentica a los usuarios.
Las integraciones de API pueden enviar los siguientes tipos de datos a Datadog:
Puedes incluir recursos listos para utilizar como monitores, dashboards y pipelines de logs con tu integración de API. Cuando un usuario hace clic en Install (Instalar) en tu cuadro de integración, se le pide que siga las instrucciones de configuración, y todos los dashboards listos para utilizar aparecen en su cuenta. Otros recursos, como los pipelines de logs, aparecen para los usuarios después de una correcta instalación y configuración de la integración.
Para mostrar tu oferta en las páginas Integraciones o Marketplace, debes crear un cuadro (imagen a continuación). Este cuadro incluirá instrucciones sobre cómo configurar tu oferta, así como información general sobre lo que hace la integración y cómo utilizarla.
Proceso de desarrollo
OAuth
En lugar de solicitar claves de API y de aplicación directamente a un usuario, Datadog requiere el uso de un cliente OAuth para gestionar la autorización y el acceso para integraciones basadas en la API. Las implementaciones de OAuth deben admitir todos los sitios Datadog.
Para obtener más información, consulta OAuth para integraciones y Endpoints de autorización.
Para empezar, puedes explorar ejemplos que utilizan OAuth en el repositorio integrations-extras, como por ejemplo Vantage.
Crear tu integración
El proceso de creación de una API basada en integraciones tiene el siguiente aspecto:
- Una vez que te hayan aceptado en la red de socios Datadog, te reunirás con el equipo de socios tecnológicos de Datadog para analizar tu oferta y tus casos de uso.
- Solicita una cuenta sandbox de Datadog para desarrolladores.
- Comienza a desarrollar tu integración, lo que incluye escribir y alojar código de integraciones en tu extremo, así como implementar el protocolo OAuth.
- Prueba tu integración y tu cliente OAuth en tu cuenta sandbox de Datadog.
- Una vez que tu trabajo de desarrollo haya sido probado y completado, sigue los pasos en Crear un cuadro, para mostrar tu integración en la página Integraciones o Marketplace.
- Una vez enviada y aprobada tu solicitud de extracción, el equipo de socios tecnológicos de Datadog programará una demostración de la revisión final de tu integración.
- Tendrás la opción de probar el cuadro y la integración en tu cuenta sandbox de Datadog antes de publicar o de publicar inmediatamente la integración para todos los clientes.
Empieza a crear tu integración de API creando un cuadro.
Actualizar tu integración
Puedes actualizar tu integración en cualquier momento editando los archivos relevantes y abriendo una nueva solicitud de extracción en el directorio de tu integración, en el repositorio integrations-extras.
En el caso de las integraciones basadas en la API, se recomienda actualizar la versión de una integración cuando se añaden nuevas funciones, como el envío de nuevos datos, o cuando se corrigen errores importantes.
Si se actualiza una versión de integración, asegúrate de añadir una entrada al archivo CHANGELOG.md, que se ajuste al siguiente formato:
## Número de versión / Fecha
***Added***:
* New feature
* New feature
***Fixed***:
* Bug fix
* Bug fix
Si se editan o añaden nuevos contenidos LÉEME, información de manifiestos o recursos como dashboards y monitores recomendado, no es necesario actualizar la versión.
Las actualizaciones de recursos como los dashboards y los monitores recomendados están disponibles para los clientes una vez que se han combinado las solicitudes de extracción correspondientes y se han publicado los recursos. Las actualizaciones de README.md, manifest.json o de cualquier otro archivo que no sea de código también están disponibles inmediatamente para los clientes tras su publicación.
Leer más
Más enlaces, artículos y documentación útiles:
