API externa

Las API externas son la forma en que Chakra se comunica con el mundo exterior. Con ellas puedes modelar cualquier tipo de integración de API en nuestro sistema. Es tan sencillo como usar un cliente HTTP, como Postman o Insomnia. Las API externas te ayudan a obtener o enviar datos desde tus aplicaciones internas u otros productos de software.

Métodos HTTP

La API externa es compatible con los métodos HTTP estándar

GET
POST
PUT
PATCH
DELETE
OPTIONS
HEAD

Tipo de cuerpo de la solicitud

Se admiten los tipos estándar de cuerpo de solicitud HTTP. A continuación, se incluye una lista:

NONE
JSON
FORM-MULTIPART
XML
FORM-URL-ENCODED

Otras configuraciones

También puedes configurar

encabezados de solicitud
parámetros de consulta

Transformación de solicitud/respuesta

Tanto las cargas útiles de solicitud como las de respuesta se pueden transformar con nuestro marco estándar de transformadores. Para casos de uso más complejos, también puedes elegir usar JSONata. Esto resulta especialmente útil cuando el formato de los datos externos es incompatible con el formato de datos de Chakra. JSONata es Turing completo, lo que significa que puedes escribir lógica arbitraria para realizar tus transformaciones

Almacenamiento en caché

Puedes habilitar el almacenamiento en caché en tus API externas. Esto resulta especialmente útil cuando los datos obtenidos cambian con poca frecuencia y tener datos ligeramente desactualizados no afecta demasiado la lógica de tu negocio. Las API en caché también son más rápidas, lo que mejora la latencia y la experiencia del usuario

Alertas de errores

Puedes configurar alertas de errores para recibir una notificación cada vez que se produzca un error en una API. Las alertas se envían por correo electrónico y solo pueden enviarse a usuarios de Chakra. También puedes definir criterios de error personalizados para tu API. De forma predeterminada, una respuesta que no sea 2xx se considera un error.

Registros

Las solicitudes y respuestas de las API externas se registran. De forma predeterminada, solo se registran las solicitudes que generan errores. Puedes cambiar esta configuración para registrar todas las solicitudes