API Adresse — Guide d'intégration

Comment connecter les endpoints de suggestion et de validation DQE pour une qualité d'adresse optimale avec un minimum d'appels API inutiles.

Modèles d'intégration

DQE recommande une approche à deux niveaux :

• Niveau 1 - Suggestion d'adresse - choisissez la ligne unique ou la saisie progressive selon la conception de votre formulaire
• Niveau 2 - Filet de sécurité de validation RNVP - déclenchez-le uniquement lorsque l'utilisateur a saisi du texte libre ou modifié une suggestion DQE

Flux d'intégration

Champ Label - affichage uniquement

Le champ Label est formaté uniquement pour la liste déroulante de suggestions. Son format varie selon le pays et peut inclure des séparateurs, des parenthèses ou des numéros entre crochets. Ne l'utilisez pas pour remplir les champs d'adresse - utilisez toujours les champs structurés renvoyés avec lui.

Les numéros de rue entre crochets (ex. [30] RUE DE LA PAIX) indiquent que le numéro n'a pas été trouvé dans la base de référence DQE. DQE renvoie néanmoins le reste de l'adresse correctement formaté afin que les utilisateurs puissent poursuivre. Il est recommandé d'afficher les numéros entre crochets dans un style atténué pour signaler que le numéro peut nécessiter une vérification - il pourrait apparaître dans une future mise à jour de la base de données.

Rue sélectionnée sans numéro

Lorsqu'un utilisateur sélectionne une rue sans saisir de numéro, l'API renvoie la correspondance de rue mais signale que des numéros existent pour cette rue. Détectez ce cas et présentez les numéros disponibles à partir de la réponse déjà reçue - aucun appel API supplémentaire n'est nécessaire. Cela s'applique à tous les modes d'autocomplétion : API Standard SINGLEV2 et ADR, RESTful SINGLE et FunnelAddress.

Condition de détection

Champ Complement

Associez votre champ de formulaire de complément à Complement (Classic : SINGLEV2 / ADR) ou AdditionalAddress (RESTful : single / funneladdress).

Après que l'utilisateur a sélectionné une adresse, appelez l'étape de complément dédiée - COMPLV2 / COMPL (Classic) ou compl / funnelcompl (RESTful) - et présentez les options renvoyées à l'utilisateur.

Langue des résultats renvoyés

Pour la plupart des pays, les données d'adresse existent dans une seule langue et la langue des résultats renvoyés dépend entièrement de la base de référence - vous ne pouvez pas la modifier.

Pour certains pays, la base de données contient des entrées dans plusieurs langues ou écritures. Dans ce cas, le paramètre Langue agit comme un filtre de langue strict : seuls les résultats correspondant à la langue demandée sont renvoyés. Sans ce paramètre, toutes les versions linguistiques peuvent être renvoyées simultanément.

Pays où Langue filtre par langue

Correction d'adresse (RNVP)

Lorsqu'un appel RNVP est déclenché, affichez la correction à l'utilisateur sous forme de popup, en préservant toujours la possibilité de conserver sa saisie d'origine. Ajoutez Modification=O à la requête pour recevoir une décomposition champ par champ.

Messages utilisateur recommandés par code de validation

Le code de validation (DQECodeDetail dans l'API Classic, DQEDetailCode dans l'API RESTful) indique la qualité de l'adresse renvoyée par l'API. Le tableau ci-dessous associe chaque code à une description interne (pour les équipes support et intégration) et à un message recommandé pour l'utilisateur final.