Ir para o conteúdo

Verbos de API no Wevo iPaaS

No processo de criação de flow, um dos triggers que podem ser usados para iniciar um flow é o trigger da API (consulte Criação de flow para detalhes). Isso significa que quando você seleciona essa opção, um endpoint será gerado automaticamente para seu flow, permitindo que outros aplicativos o utilizem para enviar dados a serem integrados.

Ao criar um flow com um trigger de API, na tela Design de flow, você pode clicar no ícone do trigger para configurar informações sobre o endpoint (consulte Configurar ou modificar um trigger para detalhes). Uma dessas configurações é qual verbo (método) esse endpoint deve aceitar quando ativado.

verbos api 1

Uma comunicação de API usa o protocolo HTTP para obter registros e há alguns verbos que você pode escolher. Eles são descritos abaixo:

  • GET: Em uma solicitação GET, os dados são retornados no formato JSON, junto com um código de status de resposta, que será 200 quando a solicitação for bem-sucedida. Este verbo pode ser usado apenas para leitura de dados.

  • POST: Uma solicitação POST permite a criação de novos registros. Isso significa que, quando você a usa, novos dados serão inseridos no endpoint. Uma utilização bem-sucedida do verbo POST retornará um código de status 201.

  • PUT: Este verbo é usado para substituir, ou atualizar, registros. Uma atualização bem-sucedida retornará um código de status de 200.

  • DELETE: Uma solicitação usando este verbo pode ser usada para excluir um registro identificado por uma URL.

  • PATCH: Ao fazer uma solicitação PATCH, você poderá modificar parcialmente um registro. A solicitação precisa conter apenas as alterações específicas para o corpo do registro, não o registro inteiro.