API Trigger
Saiba mais sobre o API Trigger e como usá-lo na Digibee Integration Platform.
Atualizado
Saiba mais sobre o API Trigger e como usá-lo na Digibee Integration Platform.
Atualizado
O API Trigger expõe uma integração através de um endpoint REST. Quando um pipeline é configurado e implantado com esse trigger, um endpoint REST é gerado automaticamente. Você pode visualizar esse endpoint no cartão do pipeline na página Run após a implantação.
Para começar a configurar o trigger, siga estes passos para configurar a Routes List:
Na seção Routes List, clique em Adicionar.
Insira o Path (por exemplo, "/users").
Selecione o Method apropriado.
Adicione uma descrição no campo Summary (como "Recupera todos os usuários").
Depois de criar a rota, ela aparecerá na Routes List. Você pode adicionar novas rotas, editar as rotas existentes ou excluí-las.
Alternativamente, você pode criar um pipeline com um arquivo de especificação OpenAPI. Saiba mais sobre como criar um pipeline a partir de uma especificação OpenAPI.
Após salvar a configuração do trigger, uma representação visual das rotas será exibida no pipeline.
As rotas só podem ser editadas através do formulário de configuração do trigger. Depois de salvar, quaisquer alterações serão refletidas imediatamente no pipeline.
Cada rota é conectada a um conector Block Execution, que é projetado para separar logicamente a integração em subfluxos diferentes, facilitando o gerenciamento do pipeline. Para concluir a configuração, você precisará criar os fluxos para cada rota dos subfluxos OnProcess e OnException.
Informações importantes:
Se você criar o fluxo antes de configurar o trigger, os conectores existentes serão desconectados assim que o trigger for configurado.
Excluir uma rota da Routes List irá desconectar o conector Block Execution desta rota do fluxo principal.
Alterar o API Trigger para outro tipo de trigger converterá o Router em um conector Choice, e as rotas configuradas anteriormente serão automaticamente conectadas ao Choice.
Em cada um desses casos, você pode copiar os conectores dentro de cada Block Execution e colá-los em outra parte do pipeline.
Dê uma olhada nos parâmetros de configuração do trigger. Parâmetros suportados por expressões Double Braces estão marcados com (DB)
.
Há um parâmetro de configuração global que especifica que todos os pipelines devem ser publicados com pelo menos as opções API Key ou Basic Auth habilitadas.
Abaixo você encontra mais detalhes sobre os parâmetros:
Parâmetro | Descrição | Valor padrão | Tipo de dado |
---|---|---|---|
Maximum Timeout
Tempo máximo (em milissegundos) para o pipeline processar as informações antes de retornar uma resposta. Limite: 900000 ms.
30000
Integer
The Maximum Allowed Request Size In Mb
Tamanho máximo do payload (em MB). O tamanho configurável máximo é de 5 MB.
5
Integer
Response Headers (DB)
Headers retornados pelo endpoint quando o processamento do pipeline for concluído. Este parâmetro é obrigatório.
N/A
String
Add Cross-Origin Resource Sharing (CORS)
Habilita a adição de headers CORS.
False
Booleano
CORS Headers
Headers CORS retornados pelo endpoint quando o processamento do pipeline for concluído. Disponível apenas se o parâmetro Add Cross-Origin Resource Sharing (CORS) estiver ativo.
N/A
Par de chave-valor
External API
Se ativo, publica a API em um gateway externo.
True
Booleano
Internal API
Se ativo, publica a API em um gateway interno. As opções External API e Internal API podem estar ativas simultaneamente.
False
Booleano
mTLS Enabled API
Se ativo, publica a API em um gateway dedicado com mTLS habilitado por padrão.
False
Booleano
API Key
Se ativo, o endpoint só pode ser consumido se uma chave de API estiver configurada na Digibee Integration Platform.
False
Booleano
Token JWT
Se ativo, o endpoint só pode ser consumido se um token JWT gerado por outro endpoint for enviado. Saiba mais no artigo sobre implementação do Digibee JWT..
False
Booleano
Basic Auth
Se ativo, o endpoint só pode ser consumido se a autenticação Basic Auth estiver presente na requisição. Essa configuração pode ser registrada previamente na página Consumers na Digibee Integration Platform.
False
Booleano
Rate Limit
Se ativo, aplica a limitação de taxa no gateway da API. Disponível apenas se os parâmetros API Key ou Basic Auth estiverem ativos.
False
Booleano
Limit by
Define a entidade à qual os limites serão aplicados. Disponível apenas se o parâmetro Rate Limit estiver ativo.
API
String
Aggregate by
Define a entidade para agregar os limites. Opções: Consumer e Credential (API Key, Basic Auth). Disponível apenas se o parâmetro Rate Limit estiver ativo.
Consumer
String
Options
Define o limite de requisições que podem ser feitas dentro de um intervalo de tempo. Disponível apenas se o parâmetro Rate Limit estiver ativo.
N/A
Opções de Rate Limit
Interval
Define o intervalo de tempo para o limite de requisições. Opções: second, minute, hour, day, e month. Disponível apenas se uma nova opção (Option) for adicionada.