N-Ways
Documentation développeursValidation d’adresse

Validation d’adresse

Repérez une adresse fausse ou incomplète avant le départ du livreur : un verdict, l’adresse et le code postal corrigés, et un point où livrer.

Sur cette page

Une adresse erronée fait perdre du temps et de l’argent au livreur. La validation d’adresse en vérifie une avant que vous acceptiez la commande : existe-t-elle, où se trouve-t-elle exactement, et comment faut-il l’écrire ? Elle comprend les codes postaux NIPOST, les codes GhanaPost GPS et les Plus Codes présents dans le texte, et complète le code postal quand il manque.

Vérifier une adresse

cURL
curl -X POST "https://nways.ng/maps/v1/addresses/validate?key=VOTRE_CLE_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: 'VOTRE_CLE_API' })
const check = await nways.validateAddress('12 Allen Avenue, Ikeja, Lagos', { country: 'NG' })
if (check.verdict.status === 'UNRESOLVED') askTheCustomerAgain()
ChampDescription
addressObligatoire. L’adresse telle qu’elle a été écrite, jusqu’à 300 caractères.
countryNG, GH, BJ, TG, GA, CI, LR, GN, SL, GW, SN, CM, BF ou CV : où chercher.
near{ lat, lng } : où elle devrait se trouver (la dernière livraison du client, le quartier de la boutique).
langen ou fr.

La réponse

ChampDescription
verdict.statusVALID (trouvée, jusqu’au bâtiment), VALID_WITH_CORRECTIONS (trouvée, avec des éléments corrigés ou ajoutés), PARTIAL (seulement jusqu’à la rue ou au quartier), UNRESOLVED (introuvable), INVALID (un code qui ne peut pas exister).
verdict.granularitySa précision : PREMISE, POINT, ROUTE (la rue), NEIGHBOURHOOD, LOCALITY, REGION ou NONE.
verdict.confidenceDe 0 à 1.
verdict.codesAgreeQuand le texte contient à la fois un code et des mots : s’ils désignent le même endroit.
formattedAddressL’adresse telle qu’elle doit être écrite.
componentsSes éléments (premise, street, neighbourhood, locality, lga, region, postcode…), chacun avec sa source : input (confirmé), corrected, inferred (ajouté par nous) ou unconfirmed.
location, accuracyMOù livrer, sous forme de point GeoJSON, et avec quelle précision.
postcodeAu Nigeria, le code postal NIPOST du bâtiment avec ses entrées, quand N-Ways les connaît.
issuesCe qui ne va pas ou mérite d’être vérifié, chacun avec un code et un message.

Qu’en faire

VerdictAction suggérée
VALIDAcceptez. Enregistrez location et le code postal avec la commande.
VALID_WITH_CORRECTIONSAcceptez, et montrez au client la formattedAddress pour qu’il la confirme.
PARTIALDemandez un point de repère, un numéro de maison ou un numéro de téléphone pour le livreur.
UNRESOLVED, INVALIDDemandez plutôt au client de placer une épingle sur la carte.