Validação de endereços

Detete um endereço errado ou incompleto antes de o estafeta partir: um veredicto, o endereço e o código postal corrigidos, e um ponto onde entregar.

Nesta página

Verificar um endereço
A resposta
O que fazer com ela

Um endereço errado faz o estafeta perder tempo e dinheiro. A validação de endereços verifica um endereço antes de aceitar a encomenda: existe, onde fica exatamente e como deve ser escrito? Compreende os códigos postais NIPOST, os códigos GhanaPost GPS e os Plus Codes presentes no texto, e completa o código postal quando falta.

Verificar um endereço

cURL

curl -X POST "https://nways.ng/maps/v1/addresses/validate?key=A_SUA_CHAVE_API" \
  -H "Content-Type: application/json" \
  -d '{"address": "12 Allen Avenue, Ikeja, Lagos", "country": "NG"}'

JavaScript

import { createClient } from '@nways/maps'

const nways = createClient({ key: 'A_SUA_CHAVE_API' })
const check = await nways.validateAddress('12 Allen Avenue, Ikeja, Lagos', { country: 'NG' })
if (check.verdict.status === 'UNRESOLVED') askTheCustomerAgain()

Campo	Descrição
`address`	Obrigatório. O endereço tal como foi escrito, até 300 caracteres.
`country`	`NG`, `GH`, `BJ`, `TG`, `GA`, `CI`, `LR`, `GN`, `SL`, `GW`, `SN`, `CM`, `BF` ou `CV`: onde procurar.
`near`	`{ lat, lng }`: onde deveria ficar (a última entrega do cliente, a zona da loja).
`lang`	`en` ou `fr`.

A resposta

Campo	Descrição
`verdict.status`	`VALID` (encontrado, até ao edifício), `VALID_WITH_CORRECTIONS` (encontrado, com partes corrigidas ou acrescentadas), `PARTIAL` (só até à rua ou ao bairro), `UNRESOLVED` (não encontrado), `INVALID` (um código que não pode existir).
`verdict.granularity`	A sua precisão: `PREMISE`, `POINT`, `ROUTE` (a rua), `NEIGHBOURHOOD`, `LOCALITY`, `REGION` ou `NONE`.
`verdict.confidence`	De 0 a 1.
`verdict.codesAgree`	Quando o texto tem um código e palavras: se apontam para o mesmo lugar.
`formattedAddress`	O endereço tal como deve ser escrito.
`components`	As suas partes (`premise`, `street`, `neighbourhood`, `locality`, `lga`, `region`, `postcode`…), cada uma com a sua `source`: `input` (confirmada), `corrected`, `inferred` (acrescentada por nós) ou `unconfirmed`.
`location`, `accuracyM`	Onde entregar, como ponto GeoJSON, e com que precisão.
`postcode`	Na Nigéria, o código postal NIPOST do edifício com as suas entradas, quando o N-Ways os conhece.
`issues`	O que está errado ou merece ser verificado, cada um com um `code` e uma `message`.

O que fazer com ela

Veredicto	Ação sugerida
`VALID`	Aceite. Guarde `location` e o código postal com a encomenda.
`VALID_WITH_CORRECTIONS`	Aceite, e mostre ao cliente o `formattedAddress` para que o confirme.
`PARTIAL`	Peça um ponto de referência, um número de porta ou um número de telefone para o estafeta.
`UNRESOLVED`, `INVALID`	Peça antes ao cliente que marque um ponto no mapa.