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/smartflow/getFlow
- 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]

Descobrir fluxo​

GET
/api/v1/smartflow/flows/{flowId}

Retorna a definição do fluxo: os passos habilitados na ordem canônica (steps), quais deles são capturas com link hospedado (handoffSteps) e os campos personalizados (fields). A ordem dos passos é fixa pelo produto; um fluxo varia apenas em quais passos possui. flowId é o id do próprio fluxo, não a chave pública do embed.

Authorizations​

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Parameters​

Path Parameters

flowId*

Identificador do fluxo (flowId).

Type
string
Required

Responses​

Definição do fluxo.

application/json
JSON
{
  
"flowId": "string",
  
"steps": [
  
  
[
  
  
  
"basic",
  
  
  
"email",
  
  
  
"phone",
  
  
  
"custom",
  
  
  
"facematch",
  
  
  
"driver-license"
  
  
]
  
],
  
"handoffSteps": [
  
  
[
  
  
  
"facematch",
  
  
  
"driver-license"
  
  
]
  
],
  
"fields": [
  
  
{
  
  
  
"id": "f_k3n8p2q7",
  
  
  
"type": "text",
  
  
  
"label": "Matrícula",
  
  
  
"required": true,
  
  
  
"maxLength": 20,
  
  
  
"options": [
  
  
  
  
"string"
  
  
  
]
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI