api rest

destino

envia os dados do upstream para um endpoint http em lotes. suporta autenticação via vault e envio de payload json.

---

casos de uso

• notificar sistemas externos ao processar dados (crm, erp, webhooks)
• sincronizar dados processados via api de terceiros
• acionar workflows externos com payload de dados

---

configuração

campo	tipo	obrigatório	descrição
url	string	sim	endpoint de destino. suporta {{variavel}}
method	enum	não	POST, PUT, PATCH · padrão: POST
credential_id	uuid	não	id da credencial para autenticação
batch_size	number	não	registros por requisição · padrão: 1 (um por request)
headers	lista	não	pares key/value de headers adicionais

---

exemplos

post individual por registro

{
  "url": "https://crm.exemplo.com/api/v2/contatos",
  "method": "POST",
  "credential_id": "uuid-da-credencial"
}

cada registro do upstream é enviado como um objeto json individual.

post em lotes de 50

{
  "url": "https://api.exemplo.com/v1/bulk/pedidos",
  "method": "POST",
  "credential_id": "uuid-da-credencial",
  "batch_size": 50
}

os registros são agrupados em arrays de 50 e enviados em uma requisição por lote.

put com autenticação bearer

{
  "url": "https://api.exemplo.com/v1/sync/clientes",
  "method": "PUT",
  "credential_id": "uuid-da-credencial"
}

a credencial do tipo bearer adiciona automaticamente o header:

Authorization: Bearer {token}

---

payload enviado

batch_size = 1 (padrão): cada registro é enviado como objeto json:

{ "id": 1, "nome": "João", "email": "joao@email.com" }

batch_size > 1: registros são agrupados em array:

[
  { "id": 1, "nome": "João", "email": "joao@email.com" },
  { "id": 2, "nome": "Maria", "email": "maria@email.com" }
]

---

autenticação

usa as mesmas credenciais do vault que o conector de fonte api rest:

tipo	configuração
bearer	adiciona Authorization: Bearer {token}
basic	adiciona Authorization: Basic {base64}
api_key	adiciona header customizado com a chave

---

branch developer

em pipelines no branch developer, este conector é bloqueado. nenhuma requisição http é enviada para sistemas externos.