Documentación de la API de Kaizala

  • Artículo

Antes de empezar, consulte Configuración para usar los conectores de Kaizala.

Dominio raíz

El dominio raíz para invocar las API de Kaizala es:

{endpoint-url}
Parámetro Tipo ¿Opcional? Descripción
Dirección URL del punto de conexión endpoint-url Cadena No Si la autenticación se realiza correctamente al generar tokens de acceso, se devuelve una dirección URL del punto de conexión que se debe usar como api-base-url para realizar llamadas API posteriores.

Al presionar cualquier api de Kaizala, puede obtener el código de estado Http:308 que indica que la dirección URL del punto de conexión del usuario ha cambiado. En ese caso, la ubicación del encabezado de respuesta contendrá la nueva dirección URL del punto de conexión.

Sugerencia: Los clientes pueden configurar el tiempo de espera para recibir la respuesta de las API de Kaizala a 1 minuto

Puntos finales de API

La API de Kaizala se ejecuta en la nube segura de Microsoft Azure e interactúa con la plataforma Kaizala para realizar diversas acciones para los usuarios finales. La API funciona con los siguientes recursos de Kaizala:

La API de Kaizala tiene límites de limitación de

  • 100 llamadas por minuto por conector
  • 300 llamadas por minuto por inquilino (entre conectores)

Cuando se supera el límite de limitación, la API devolverá el valor "Retry-After" junto con el código de estado Http:429. El valor "Retry-After" especifica cuántos segundos esperar antes de realizar otra solicitud.

WebHooks

La API de Kaizala de Microsoft también proporciona una manera para que los desarrolladores se registren para eventos específicos dentro de la plataforma de Kaizala a través de WebHooks.

Colección Postman

Para probar nuestras API, así como comprender el esquema de la API de Kaizala, puede importar la colección postman que contiene ejemplos y esquema para todas las api de Microsoft Kaizala:

Ejecución en Postman

Establezca las siguientes variables de entorno en "Kaizala-API-environment" antes de ejecutar el proyecto postman:

  • mobile-number: número de móvil que se usará para invocar api
  • application-id: identificador asociado al conector
  • application-secret: secreto asociado al conector

Otras variables de entorno se rellenarán automáticamente al probar las API en la mención de secuencia en Postman Project.

Introducción a las API REST de Kaizala

Ejemplo de C# (compartido)