API

Entenda o que é um pipeline API na Digibee Integration Platform e como ele simplifica a criação e configuração de integrações baseadas em HTTP.

O que é um pipeline API

Um pipeline API permite configurar um pipeline com o API Trigger sem precisar abrir o Canvas desde o início. Você define os endpoints, a autenticação, o rate limiting e o CORS por uma interface dedicada na página de Pipelines, e a plataforma gera a estrutura do Canvas automaticamente.

O resultado é um pipeline com todas as rotas já configuradas e estruturado seguindo boas práticas. Para abrir o Canvas a qualquer momento, clique no botão de três pontos no card do pipeline e selecione Abrir Canvas. Você também pode configurar o API Trigger por lá.

Como funciona

Ao criar um pipeline API, a plataforma monta automaticamente a seguinte estrutura no Canvas:

• Um API Trigger como ponto de entrada do pipeline.

• Um Router conectado ao trigger, responsável por direcionar as requisições para a rota correta.

• Um conector Block Execution ao final de cada rota, organizando o pipeline em subfluxos.

• Subfluxos OnProcess e OnException dentro de cada Block Execution, para tratamento de respostas de sucesso e erro.

• Um menu Endpoints na barra lateral esquerda, com acesso rápido a todas as rotas configuradas.

Cada endpoint adicionado pela interface gera automaticamente essa estrutura no Canvas. Você pode configurar a lógica de cada rota abrindo os subfluxos OnProcess e OnException diretamente pela coluna Ações na interface de configuração.

Pipeline API e pipeline REST

Ambos utilizam triggers HTTP e compartilham o mesmo ícone na listagem de pipelines. A diferença está na forma de criação e configuração:

	Pipeline API	Pipeline REST
Criação	Interface dedicada na página de Pipelines ou Canvas	Canvas
Configuração de rotas	Interface dedicada ou Canvas	Canvas
Estrutura gerada automaticamente	Sim	Não
Acesso ao Canvas	Disponível a qualquer momento	Abre por padrão

Para identificar o tipo de trigger de um pipeline na listagem, passe o cursor sobre o card. Um tooltip exibe se o trigger é API ou REST.

Pipelines criados com o API Trigger antes desta funcionalidade também são atualizados para esse modelo e podem ser configurados pela interface dedicada ou diretamente no Canvas.

Resumo

• Um pipeline API é criado e configurado por uma interface dedicada na página de Pipelines, sem precisar abrir o Canvas desde o início.

• A estrutura no Canvas (trigger, router, Block Execution e subfluxos) é gerada automaticamente a partir dos endpoints configurados.

• O Canvas permanece acessível a qualquer momento para ajustes e configurações avançadas.

• Pipelines REST não são afetados por essa funcionalidade.

Próximos passos

Agora que você entende o conceito, leia Como criar um pipeline API para configurar seu primeiro pipeline passo a passo.