Pular para o conteúdo
Docs
API Conhecer a Zariv

OpenAPI

A especificação da API pública em formato OpenAPI 3, para importar em ferramentas de teste e gerar clientes em qualquer linguagem.

A mesma descrição que você lê nestas páginas está disponível em formato de máquina. Ela é gerada a partir dos mesmos dados da documentação, então as duas nunca divergem.

Arquivo OpenAPI 3.0.3
https://docs.zariv.com.br/openapi.json

Abrir openapi.json

#Para que serve

  • Testar sem programar: importe o arquivo no Postman, Insomnia, Bruno ou Swagger UI e informe a chave em Bearer token.
  • Gerar um cliente pronto: ferramentas como o OpenAPI Generator criam bibliotecas em TypeScript, Python, PHP, Java, C# e outras.
  • Dar contexto a assistentes de IA: cole a URL do arquivo para que o assistente entenda as rotas e escreva a integração.

#Importar no Postman ou Insomnia

  1. Importe a URL
    Use a opção Import e cole o endereço do openapi.json.
  2. Configure a autenticação
    Escolha Bearer Token e cole a sua chave (nmx_…).
  3. Envie a primeira requisição
    Abra GET /imoveis e clique em enviar.

#Gerar um cliente

Exemplo com TypeScript
npx @openapitools/openapi-generator-cli generate \
  -i https://docs.zariv.com.br/openapi.json \
  -g typescript-fetch \
  -o ./cliente-zariv