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.

Como obter uma chave

Você obtém uma chave assinando no console. Não há fila de aprovação nem e-mail a enviar.

Entre no console ou crie uma conta. É a mesma conta que você usa para os outros produtos Housing Market.
Escolha os países, uma região ou o mundo todo, o plano e o faturamento mensal ou anual.
Informe o endereço IP a partir do qual seus servidores vão chamar a API.
Aceite os termos de uso da API. Mantemos um registro do que você aceitou e de quando aceitou.
Pague. Sua chave aparece somente depois que o pagamento for concluído, e é exibida uma única vez.

Copie a chave diretamente para o seu cofre de segredos. Armazenamos apenas um hash unidirecional dela, por isso não podemos exibi-la novamente. Uma chave tem o formato hma_<prefix>_<secret>.

Você pode criar uma chave substituta no console a qualquer momento. A chave antiga continua funcionando por 24 horas depois disso, para que você faça a troca sem interrupção do serviço.

Estados da chave

Ativa: a chave funciona.
Pausada: a chave é recusada com key_paused. Ela volta a funcionar sozinha quando o motivo é resolvido.
Revogada: a chave é recusada permanentemente com unauthenticated.

Se um pagamento de renovação falhar, sua chave continua funcionando durante um período de carência de 5 dias, enquanto enviamos e-mails a você a cada etapa, e depois é pausada. Uma chave pausada volta a funcionar automaticamente assim que o pagamento é regularizado. Uma contestação de pagamento pausa a chave imediatamente até que seja analisada.

Adicionar um país ou fazer upgrade é cobrado de forma proporcional imediatamente e se aplica à mesma chave logo após a confirmação do pagamento. Remover um país ou fazer downgrade entra em vigor na próxima renovação.