Documentação da API kaizala

Artigo
04/04/2023

Antes de começar, consulte Configuração para usar os Conectores kaizala

Domínio Raiz

O domínio raiz para invocar as APIs Kaizala é:

{endpoint-url}

	Parâmetro	Tipo	Opcional?	Descrição
Url do ponto de extremidade	`endpoint-url`	Cadeia de caracteres	Não	Em auth bem-sucedido ao gerar tokens de acesso, uma url de ponto de extremidade é retornada que deve ser usada como api-base-url para fazer chamadas de API subsequentes

Ao clicar em qualquer api kaizala, você pode obter o código de status Http:308 indicando que o ponto de extremidade do usuário foi alterado. Nesse caso, o local do cabeçalho de resposta conterá o novo ponto de extremidade-url.

Sugestão: Os clientes podem configurar o tempo limite para receber a resposta das APIs kaizala em 1 minuto

Pontos de extremidade da API

A API kaizala é executada na nuvem segura do Microsoft Azure e interage com a plataforma Kaizala para executar várias ações para usuários finais. A API funciona com os seguintes recursos kaizala:

A API kaizala tem limites de limitação de

100 chamadas por min por conector
300 chamadas por min por locatário (entre conectores)

Quando o limite de limitação exceder, a API retornará o valor "Retry-After" junto com o código de status http:429. O valor "Retry-After" especifica quantos segundos aguardar antes de fazer outra solicitação.

WebHooks

A API do Microsoft Kaizala também fornece uma maneira de os desenvolvedores se registrarem para eventos específicos na plataforma Kaizala por meio de WebHooks.

/webhook

Coleção Postman

Para testar nossas APIs, bem como entender o esquema da API kaizala, você pode importar a coleção de postmans contendo exemplos e esquema para todos os apis do Microsoft Kaizala:

Defina as seguintes variáveis de ambiente em "Kaizala-APIs-environment" antes de executar o projeto do postman:

número de celular: seu número de celular que será usado para invocar apis
application-id : ID associada ao Conector
segredo do aplicativo: segredo associado ao Conector

Outras variáveis de ambiente serão preenchidas automaticamente ao experimentar as apis na menção de sequência no Projeto Postman.

Introdução às APIs REST do Kaizala

Exemplo de C# (compartilhado)