Introdução
A Address Analyzer API é uma API RESTful capaz de analisar endereços brasileiros e sugerir correções, retornando o endereço separado em campos e com a grafia oficial. Com a Address [...]
Address Analyzer
Posts
Construindo requisições para a Address Analyzer API
Antes de começar a usar a API, será necessário obter o token de autenticação. Os seguintes headers serão necessários, onde a palavra token deverá ser substituída pelo token obtido [...]
Lista de parâmetros
Formatos de envio do endereço O endereço pode ser enviado de duas formas: Os dois formatos podem ser enviados na mesma requisição. Nesse caso, os parâmetros estruturados têm preced [...]
Estrutura da resposta
Na resposta, teremos os seguintes campos: Nota: quando o status for CORRECTED, os campos district e state serão preenchidos mesmo que não tenham sido enviados. Quando o status for [...]
Exemplos
Exemplo 1 – Endereço com sugestão de correção Nesse exemplo, temos um endereço enviado no formato label, com o tipo de logradouro abreviado, o CEP com hífen e a cidade sem acento. [...]
Status Codes
Abaixo a tabela com os status codes para cada endpoint disponível na Address Analyzer API: Código Método Endpoint Descrição 200 POST https://api.maplink.global/address/v1/analyzer [...]
Error messages
A tabela a seguir mostra todas as mensagens de erro que podem ser retornadas pela API no campo message: Parâmetro Mensagem Descrição zipcode / label The zipcode field must contain [...]
