API externa

As APIs externas são a forma como a Chakra se comunica com o mundo exterior. Com elas, você pode modelar qualquer tipo de integração de API no nosso sistema. É tão simples quanto usar um cliente HTTP como Postman ou Insomnia. As APIs externas ajudam você a buscar/enviar dados dos seus aplicativos internos ou de outros produtos de software.

Métodos HTTP

A API externa oferece suporte aos métodos HTTP padrão

GET
POST
PUT
PATCH
DELETE
OPTIONS
HEAD

Tipo de corpo da solicitação

Há suporte aos tipos padrão de corpo de solicitação HTTP. Veja a lista abaixo:

NONE
JSON
FORM-MULTIPART
XML
FORM-URL-ENCODED

Outras configurações

Você também pode configurar

cabeçalhos da solicitação
parâmetros de consulta

Transformação de solicitação/resposta

Os payloads de solicitação e resposta podem ser transformados usando nossa estrutura padrão de transformadores. Para casos de uso mais complexos, você também pode optar por usar JSONata. Isso é especialmente útil quando o formato dos dados externos é incompatível com o formato de dados da Chakra. JSONata é Turing completo, o que significa que você pode escrever lógica arbitrária para realizar suas transformações

Cache

Você pode optar por ativar o cache nas suas APIs externas. Isso é especialmente útil quando os dados buscados mudam com pouca frequência e dados um pouco desatualizados não afetam muito a lógica do seu negócio. APIs em cache também são mais rápidas, melhorando a latência e a experiência do usuário

Alertas de erro

Você pode optar por configurar alertas de erro para receber uma notificação sempre que uma API apresentar erros. Os alertas são enviados por e-mail e só podem ser enviados a usuários da Chakra. Você também pode definir critérios personalizados de erro para sua API. Por padrão, uma resposta que não seja 2xx é tratada como erro.

Registros

As solicitações e respostas de APIs externas são registradas em log. Por padrão, somente as solicitações que apresentam erros são registradas. Você pode alterar essa configuração para registrar todas as solicitações