Autenticação

Toda chamada leva uma chave de API no cabeçalho Authorization. A chave é gerada pela própria imobiliária e pode ser revogada a qualquer momento.

#Gerar uma chave

Quem administra a conta da imobiliária gera as chaves dentro do sistema:

1. Abra as configurações
   Entre na Zariv e vá em Configurações›API & Integrações.
2. Crie a chave
   Dê um nome que diga onde ela será usada (por exemplo, “Site principal”) e confirme.
3. Copie na hora
   A chave aparece uma única vez. Guarde em um gerenciador de senhas ou na configuração segura do seu servidor.

#Enviar a chave

A chave começa com nmx_ e vai no cabeçalho Authorization, no formato Bearer:

Authorization: Bearer nmx_xxxxxxxxxxxxxxxxxxxxxxxx

Guarde a chave em uma variável de ambiente (nos exemplos desta documentação, ZARIV_API_KEY) e nunca a escreva direto no código nem a envie para o controle de versão.

#O que a chave permite

Cada chave tem o escopo site_imoveis: consultar imóveis, localizações, vitrines e dados da imobiliária, e enviar contatos. Ela não dá acesso a clientes, contratos, financeiro, documentos nem ao painel do sistema.

#Revogar ou trocar

• Em Configurações›API & Integrações você vê as chaves existentes e pode revogar qualquer uma. A revogação passa a valer em até 1 minuto.
• Para trocar sem tirar o site do ar: gere a chave nova, atualize o servidor do site, confirme que funciona e só então revogue a antiga.
• Use uma chave por site ou ambiente. Assim, se uma vazar, você revoga só ela.

#Erros de autenticação