Guia de integração da Housing Market API
As tabelas de referência, as descrições dos endpoints, os códigos de erro e os exemplos são gerados a partir da especificação da API e permanecem em inglês em todos os idiomas. Nomes, parâmetros e códigos são idênticos em todos os lugares.
Autenticação
Envie sua chave no cabeçalho x-api-key de todas as solicitações.
Mantenha a chave no seu servidor. Nunca a coloque em um aplicativo móvel, em uma página web ou em um repositório público: qualquer pessoa que a tenha pode usar a sua assinatura.
Uma chave pertence a um único cliente. Não a compartilhe com outra empresa; os termos proíbem isso, e conseguimos ver de onde uma chave é usada.
Uma única chave reúne todo o seu acesso: seus países e seu plano. Quando você adiciona um país ou faz upgrade, a chave é atualizada; você não recebe uma nova.
Uma chave ausente, desconhecida ou revogada é recusada com unauthenticated. Uma chave válida usada a partir de um endereço não registrado é recusada com ip_not_allowed. Uma chave pausada é recusada com key_paused.
Exemplo de solicitação
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"