Documentation

L'API Partenaires permet aux services de livraison, aux secours, aux opérateurs de réseaux et aux administrations d'interroger le registre national en temps réel.

Format du code adresse

Le code est hiérarchique et tronquable à gauche. Chaque préfixe est lui-même une entité interrogeable.

NDJ1-2R1-M15
│   │ │ │
│   │ │ └─ M15  Maison 15
│   │ └─── R1   Rue 1
│   └───── 2    Îlot 2
└───────── NDJ1 Ville NDJ, Zone 1

Le code adresse tient lieu de code postal : il n'existe pas de numérotation postale distincte. Un centre de tri lit le code de gauche à droite et s'arrête au niveau qui le concerne.

Authentification

Chaque requête doit porter l'en-tête X-API-KEY. Les clés sont délivrées par l'administration nationale, au format chad_live_<32 caractères>, et peuvent être révoquées à tout moment.

curl https://api.adressetchad.com/api/v1/public/verify/NDJ1-2R1-M15 \
  -H "X-API-KEY: chad_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Ne placez jamais une clé dans du code exécuté par le navigateur ou dans une application mobile distribuée : appelez l'API depuis votre serveur.

Points d'entrée

MéthodeCheminDescription
GET/api/v1/public/verify/{address_code}Confirme qu'une adresse figure au registre officiel et retourne ses attributs certifiés.
GET/api/v1/public/searchRecherche par segment de code. Paramètres : q (requis), limit (optionnel).
GET/api/v1/public/street/{street_code}Retourne une rue et l'ensemble des adresses officielles qu'elle porte.
GET/api/v1/public/statsStatistiques de couverture du registre national.

Codes de réponse

200
Adresse trouvée. Le registre fait foi.
404
Le code n'existe pas ou n'est pas encore approuvé.
422
Paramètre manquant ou format de code invalide.
401 / 403
Clé absente, invalide ou révoquée.
429
Quota dépassé — ralentissez la cadence d'appel.

Obtenir une clé d'accès

L'accès à l'API Partenaires est accordé sous convention avec l'administration nationale. Décrivez votre organisation et votre cas d'usage ; une clé nominative vous sera délivrée.

Demander un accès