Developers

Aparência

Vai integrar a API REST da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/id-v3/createEnrichmentBatch
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher a API certa e fazer a primeira chamada autenticada]

Criar enriquecimentos em lote​

POST
/api/v3/enrichments/batch

Cria até 500 enriquecimentos que compartilham o mesmo perfil, options, callback e metadata, numa fila própria, separada da unitária (um lote grande nunca atrasa as consultas unitárias). Diferente da criação unitária, não há espera síncrona: a resposta é 202 assim que os itens estão gravados.

A resposta traz uma entrada por item enviado, na ordem do request, cada uma com o seu index e o seu document, o documento exatamente como enviado (sem normalização): cada documento enviado mapeia para o seu id ou o seu error. A mensagem de erro nunca traz o documento. Um item que não pode ser criado (invalid_document, profile_entity_mismatch, duplicate_in_request, invalid_metadata) traz error, não é cobrado e os demais seguem. O metadata do item sobrescreve o metadata do lote chave a chave (raso).

Problemas do request inteiro não criam nada e usam os códigos da criação unitária, além de batch_empty e batch_too_large. A mesma Idempotency-Key com o mesmo corpo devolve a primeira resposta (os documentos vêm do corpo reenviado; nada os guarda); com corpo diferente, 422 idempotency_key_reused.

Não existe endpoint de status do lote: leia cada item com GET /api/v3/enrichments/{id} ou liste-os com GET /api/v3/enrichments?batchId=. Veja Enriquecimento em lote.

Authorizations​

bearerAuth

Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.

Type
HTTP (bearer)

Parameters​

Header Parameters

Idempotency-Key

Chave de idempotência do request (do bloco), até 255 caracteres. Reenviar o mesmo bloco com a mesma chave não duplica nem cobra de novo.

Type
string
Max Length
255

Request Body​

application/json
JSON
{
  
"callback": {
  
  
"headers": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"url": "string"
  
},
  
"items": [
  
  
{
  
  
  
"document": "string",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
}
  
],
  
"metadata": {
  
  
"additionalProperties": "string"
  
},
  
"options": {
  
  
"deadline": "2h",
  
  
"modules": {
  
  
  
"additionalProperties": {
  
  
  
}
  
  
}
  
},
  
"profileId": "string"
}

Responses​

O lote foi processado; o resultado de cada item está em items, por index.

application/json
JSON
{
  
"batchId": "bat_0199a0b2-7c1e-7d4a-9f0e-3b1c2d4e5f60",
  
"created": 0,
  
"failed": 0,
  
"items": [
  
  
{
  
  
  
"document": "529.982.247-25",
  
  
  
"error": {
  
  
  
  
"code": "string",
  
  
  
  
"message": "string"
  
  
  
},
  
  
  
"id": "string",
  
  
  
"index": 0
  
  
}
  
],
  
"total": 0
}

Playground​

Authorization
Headers
Body

Samples​

Powered by VitePress OpenAPI