Introdução
A API de Validação de Endereços é uma solução inteligente para resolver detalhes de contacto incorretos e permitir a entrega mais rápida de volumes com precisão. Esta API formata adequadamente a informação do endereço do destinatário introduzido que se assemelha a um endereço válido e devolve um endereço do mundo real que é provável que seja o pretendido.
A API também fornece anotações sobre falhas no endereço introduzido ou alterações que foram feitas à entrada para chegar a esse endereço do mundo real. Pode utilizar esta API para validar e resolver a informação do endereço do destinatário antes de expedir um volume.
Nota: não utilize esta API para determinar a capacidade de entrega num endereço. A FedEx não disponibiliza serviços de entrega em todos os endereços válidos possíveis. A FedEx não faz entregas a caixas postais, exceto através de FedEx Ground® Economy (anteriormente designada por FedEx SmartPost®).
Detalhes da API da Validação de Endereços
Esta API permite validar e corrigir a informação do endereço do destinatário antes de expedir um volume. Fornecer endereços precisos na etiqueta de expedição irá ajudar a impedir atrasos na entrega e a evitar taxas adicionais para a correção de endereços (devido a falhas nos mesmos).
Nota:
- Os resultados da resolução de endereços variam segundo o país/território.
- O endereço introduzido no pedido é comparado com os dados de referência na base de dados da FedEx e o endereço com correspondência é devolvido.
Funcionalidades da API de Validação de Endereços
- Fornece correspondências de endereços ao nível da rua.
- Atualizações mensais à respetiva base de dados de endereços.
- Distingue entre endereços empresariais e residenciais caso seja detetada uma correspondência exata.
- Atualmente, não verifica números de apartamento ou suite.
Funcionalidades da API de Validação de Endereços
- Conclui os endereços do destinatário incompletos. Em alguns casos, a API de Validação de Endereços será capaz de adicionar informação em falta, consoante a verificação da informação fornecida relativamente aos dados de referência. Atualmente, a API de Validação de Endereços não consegue adicionar informação secundária em falta (por exemplo, o apartamento ou suite).
- Atualizações mensais à respetiva base de dados de endereços.
- Corrige endereços do destinatário inválidos. Por exemplo, corrige um código postal incorreto de modo a ficar em conformidade com o resto da entrada.
- Determina se um endereço é empresarial ou residencial para aumentar a precisão das cotações de tarifa de cortesia. Aplica-se apenas a endereços dos EUA e do Canadá.
- Confirma a validade e integralidade dos endereços em vários países nas seguintes regiões: EUA, Canadá, América Latina, Europa, Médio Oriente e Ásia-Pacífico. Agora já pode validar a informação de endereços nacionais e internacionais antes de expedir um volume, o que ajuda a evitar atrasos na entrega desnecessários e taxas de serviço adicionais.
- Fornece correspondências ao nível da rua.
- Verificação de até 100 endereços num único pedido da API.
Países/Territórios que Suportam a API de Validação de Endereços
Pode utilizar a API de Validação de Endereços da FedEx nos países abaixo listados para validar e corrigir os endereços do destinatário de modo a garantir entregas eficientes.
Nl. | Dinamarca | Panamá |
Argentina | República Dominicana | Peru |
Aruba | Estónia | Portugal |
Austrália | Finlândia | Singapura |
Áustria | França | África do Sul |
Baamas | Alemanha | Espanha |
Barbados | Grécia | Suécia |
Bélgica | Guatemala | Suíça |
Bermudas | RAE de Hong Kong, China | Trindade e Tobago |
Brasil | Itália | Reino Unido |
Canadá | Jamaica | Estados Unidos |
Ilhas Caimão | Malásia | Uruguai |
Chile | México | Venezuela |
Colômbia | Países Baixos | Ilhas Virgens |
Costa Rica | Nova Zelândia | |
República Checa | Noruega |
Nota: a informação devolvida pelo Pedido de Validação de Endereços é apenas uma sugestão de utilização.
Aviso de Isenção de Responsabilidade: os dados aqui fornecidos constituem informação privada e confidencial da FedEx e são fornecidos como cortesia a título do seu pedido. Não é permitida a distribuição ou divulgação de qualquer forma de parte destes dados a terceiros sem a permissão por escrito da FedEx. Estes dados refletem a atual classificação ao nível de endereços empresariais/residenciais da FedEx na respetiva base de dados de endereços de entrega e estão sujeitos a alterações. Ao fornecer esta informação, a FedEx não garante a precisão atual ou futura da mesma e não garante que os volumes expedidos para estes endereços serão faturados de acordo com a classificação empresarial/residencial fornecida. O fornecimento desta informação não constituirá uma alteração aos termos da relação entre as partes. Consulte o Guia de Serviços FedEx e os acordos de tarifas de conta aplicáveis para ver os termos e condições que regem as taxas de expedição da FedEx.
Como Funciona a API da Validação de Endereços
Validar Endereço
Utilize este ponto final para validar e resolver os endereços introduzidos e as devoluções de endereços do mundo real. Os detalhes de endereços são fornecidos e validados de modo a resolver um endereço. Um endereço é dado como resolvido quando o endereço introduzido corresponde aos dados de referência conhecidos.
As informações de introdução obrigatória associadas a este pedido são:
- Linha de Rua
- Cidade (Opcional)
- Código do Estado ou Província (Opcional)
- Código Postal (Opcional)
- Código do País
Nota: o código do estado ou o nome da cidade são suficientes quando o cliente está a expedir para um país que não tem um código postal.
A API de Validação de Endereços devolve um endereço do mundo real ao realizar as seguintes operações no endereço introduzido:
- Em primeiro lugar, a API tenta normalizar o endereço introduzido. Isto pode incluir a substituição de identificadores de endereço comuns, tais como Rua, Alameda e as respetivas abreviaturas padrão (por exemplo, "R" e "AL"), bem como a reorganização dos componentes do endereço. Se não for possível normalizar o endereço introduzido, os endereços resolvidos a devolver serão o endereço introduzido. Os valores que não corresponderem a um endereço serão eliminados.
- Em segundo lugar, a API tenta padronizar o endereço normalizado ao procurar um endereço possível ou que seja o pretendido pelo utilizador. Se a padronização falhar, os endereços resolvidos a devolver serão a forma normalizada do endereço introduzido. Observe os elementos devolvidos para ajudar a determinar os problemas do endereço submetido.
- Alguns elementos desse endereço normalizado também serão devolvidos. Se a padronização não for bem-sucedida, os endereços resolvidos a devolver serão esse endereço do mundo real. Neste caso, também serão devolvidos vários elementos adicionais do endereço padronizado e informações sobre como o mesmo foi obtido a partir do endereço normalizado.
Valores Devolvidos da API da Validação de Endereços
Se o endereço devolvido incluir os seguintes valores para os atributos abaixo indicados, o endereço é válido:
- O Estado de Endereço é Padronizado
- Os atributos do endereço resolvido surgem indicados como Verdadeiro
- O Ponto de Entrega Válido (DPV) é indicado como Verdadeiro
- O Endereço Interpolado é indicado como Falso
Se estes valores não forem apresentados, utilize os atributos adicionais para determinar os eventuais problemas com os valores do endereço.
Para obter mais informações sobre Atributos de Endereços, consulte Atributos de Endereços.
Se a mensagem de cliente devolvida como resultado for "INTERPOLATED.STREET.ADDRESS", é provável que o endereço não seja válido. Para obter mais informações sobre o código da mensagem de cliente, consulte a descrição dos elementos da mensagem de cliente.
Urbanização (apenas no Porto Rico): este descritor, normalmente utilizado em áreas urbanas de Porto Rico, é uma parte importante do formato do endereço, uma vez que descreve a localização de uma determinada rua. Em Porto Rico, é possível encontrar nomes de ruas e intervalos de números de endereço repetidos dentro do mesmo código postal. Estas ruas podem ter os mesmos intervalos de números de porta. Nestes casos, o nome da urbanização é necessário para identificar corretamente a localização de um endereço específico.
Por exemplo: Sr Pedro Rivera Urb Hermosillo 123 Calle 1 Bayamon, PR 00961-1212.
Anotações
A API de Validação de Endereços devolve anotações juntamente com todos os endereços validados e devolvidos. As anotações fornecem-lhe informações sobre as falhas (caso existam) e as alterações feitas ao endereço introduzido para chegar a esse endereço do mundo real.
Classificação do Endereço
A API de Validação de Endereços utiliza dados de referência para determinar a classificação de um determinado endereço. A classificação de um endereço funcional é calculada de forma independente do processo de validação e baseia-se no feedback dado pela equipa de operações, através da utilização de fontes de dados comerciais apenas para fins de confirmação.
A API de Validação de Endereços possui apenas quatro classificações de endereços possíveis: desconhecido, empresarial, residencial e misto. Todos os endereços começam com uma classificação "Desconhecido" e mantêm a mesma até que as regras comerciais de validação de endereços determinem que as respetivas classificações devem ser alteradas. A classificação "Misto" só é atribuída a uma localização se o endereço for de vários inquilinos e contiver tanto unidades comerciais como residenciais.
Nota: o serviço FedEx Express fornece uma linha de endereço adicional (linha de endereço 3) para os endereços de destinatários. Esta informação de endereço adicional fornece detalhes de localização mais completos e precisos que aumentam a probabilidade de obter um endereço preciso.
Os endereços do mundo real são classificados conforme o seguinte:
Endereço Empresarial
Um endereço empresarial é um endereço utilizado para designar o seu local de negócio principal. Trata-se do local no qual se presume que a empresa desenvolve a respetiva atividade, embora nem sempre seja esse o caso.
Um endereço empresarial é a localização oficial das instalações de uma empresa. Pode referir-se a vários tipos de locais, desde o endereço de casa a um campus multimilionário, à semelhança dos pertencentes a grandes empresas tecnológicas e tudo o mais dentro do género.
Endereço Residencial
Será aplicada uma taxa de entrega residencial às expedições nos EUA feitas para um domicílio ou residência privada, incluindo locais onde um negócio realize a respetiva atividade a partir de casa. Utilize o FedEx Home Delivery para entregas residenciais através do FedEx Ground no espaço de 1 dia útil, de acordo com a distância até ao destino.
Exemplo:
- Reitoria
- Convento
- Presbitério
- Residentes de edifícios multi-habitacionais, tais como:
- Apartamentos
- Condomínios
- Dormitórios universitários
- Uma residência onde se efetua a venda e/ou distribuição de produtos
Sugestões para a Utilização da API da Validação de Endereços
Seguem-se algumas sugestões úteis para a utilização da API de Validação de Endereços:
- Utilize um espaçamento correto: certifique-se de que os espaços estão colocados corretamente e evite espaços desnecessários.
- Utilize uma ortografia correta: evite quaisquer erros de ortografia e tipográficos. Certifique-se também de que utiliza corretamente o número zero (0) e a letra O.
- Evite utilizar carateres especiais: abstenha-se de utilizar carateres especiais desnecessários no endereço, tais como pontos finais após abreviaturas (Av vs. Av.).
- Forneça informações adicionais de endereço e de rua: ao fornecer informações adicionais de endereço, pode ajudar a aumentar a precisão dos resultados de endereços.
- Número de Edifício ou Porta – 1, 1A, 1½, Um
- Nome de Rua – Rua Augusto Quintino, n.º 42
- Sufixo de Rua – Estrada, Avenida, Estr, Av
- Introduza a cidade, estado/província e código postal: ao fornecer estes três dados, aumenta a precisão dos resultados de endereços.
- Introduza a rua e o endereço por ordem: normalmente, os elementos de um endereço de rua seguem um formato que começa pelo número de edifício ou porta, seguido de um elemento antes da direção (como um nome, tipo ou sufixo de rua) e um elemento após a direção (como uma designação ou número de apartamento e/ou a designação e o número de uma caixa postal privada).
- Utilize abreviaturas corretas: o Serviço Postal dos EUA e o Serviço Postal do Canadá possuem abreviaturas padronizadas para estados/províncias, sufixos de rua e designações de apartamentos ou unidades habitacionais.
- Uma abreviatura não padronizada pode afetar a precisão dos resultados de pesquisa.
- Se não tiver a certeza quanto a uma determinada abreviatura, não a utilize.
- Urbanização – o nome de uma urbanização representa uma área, setor ou empreendimento residencial dentro de uma região geográfica.
Por exemplo:
- Número de edifício ou porta, como 1, 1A, Um.
- Nome de rua, como Rua Augusto Quintino, n.º 42.
- Sufixo de rua, como Estrada, Avenida, Estr, Av.
- Introduza a cidade, estado/província e código postal: ao fornecer todas as informações do endereço, aumenta a precisão dos resultados. Os últimos dígitos do código postal não são necessários para verificar um endereço.
- Utilize abreviaturas corretas: o Serviço Postal dos Estados Unidos e as autoridades postais noutros países definem as abreviaturas padronizadas para estados/províncias, sufixos de rua e designações de apartamentos ou unidades habitacionais. Uma abreviatura não padronizada pode afetar a precisão dos resultados de pesquisa. Se não tiver a certeza quanto a uma determinada abreviatura, não a utilize.
- Pondere fornecer feedback sobre a resposta da validação de endereços ao utilizador para que este tenha a opção de escolher o endereço mais correto no respetivo caso.
Regras Empresariais
- Não utilize esta API para determinar a capacidade de entrega de um volume num endereço. A FedEx não disponibiliza serviços de entrega em todos os endereços válidos possíveis. A FedEx não faz entregas a caixas postais (exceto através de FedEx Ground® Economy (anteriormente denominada FedEx SmartPost®).
- A informação devolvida pelo endereço resolvido é apenas uma sugestão de utilização.
- Verificação de até 100 endereços num único pedido.
- O mínimo de campos obrigatórios varia entre países.
Por exemplo, para endereços dos EUA é obrigatório fornecer, pelo menos, uma linha de endereço e um código postal ou um código de cidade ou estado, mas para endereços da AUS (formato de endereço da Austrália) o código de estado pode ser omitido, mesmo sem um código postal.
- Os resultados da resolução de endereços podem variar consoante o país/território.
Nota: a API de Validação de Endereços pode não ser aplicável para todos os países. Consulte a secção Países/Territórios que Suportam a API de Validação de Endereços.
Recolha da API JSON
Response