AdresseComplète – Services Web
Services Web
La description
Trouver les adresses qui correspondent au critère de recherche.
Affiche les détails de l’adresse complète en fonction du numéro d’identification fourni.
Utiliser l’interface de programme d’application AdresseComplète
L’interface de programme d’application AdresseComplète est une option avancée pour les entreprises qui cherchent à mettre en œuvre une intégration personnalisée d’AdresseComplète.
API du service AdresseComplète
Les deux méthodes suivantes mettent en œuvre le service AdresseComplète :
- Option interactive Find d’AdresseComplète
- Option interactive Retrieve d’AdresseComplète
Aperçu de la documentation de l’API
À partir de la page de l’API, les clients peuvent sélectionner le nom du service Web pour accéder à la page des documents pour cette méthode. Chaque page contient les sections suivantes :
①
La partie supérieure de la page contient le lien vers le fichier wsdl pour les demandes SOAP à gauche et à droite, des exemples pour tous les points de terminaison RESTful et des exemples de fonctions pour un certain nombre de langages de programmation courants. Choisissez un langage d’échantillon de code, puis sélectionnez View (Afficher). L’échantillon de code s’affichera et vous pourrez le copier pour l’utiliser lors de vos propres appels au service.
②
Test
Cette section vous permet de saisir des renseignements fictifs, de simuler une demande à titre d’essai et d’afficher la réponse. Un tableau des résultats s’affichera après que vous aurez sélectionné Start the test (Commencer le test).
③
Paramètres
Cette section énumère les paramètres (facultatifs et requis) que vous devez remplir lorsque vous faites la demande.
④
Champs
Les éléments contenus dans l’objet de la réponse.
⑤
Erreurs de réponse
Messages d’erreur et leurs codes propres à un service Web particulier.
⑥
Erreurs générales
Une liste exhaustive de toutes les erreurs liées au compte et au service Web. Pas propre à une méthode de service Web en particulier.
API du service AdresseComplète
Les deux méthodes suivantes mettent en œuvre le service AdresseComplète :
- Option interactive Find (Trouver) d’AdresseComplète
- Option interactive Retrieve (Récupérer) d’AdresseComplète
Commencer une recherche normale à l’aide de la fonction Find (Trouver)
La recherche est amorcée au moyen d’une touche, et le terme de recherche complet ainsi que le code de pays ISO sont envoyés à la recherche. Invoquer la méthode à l’aide de l’événement onkeyup chaque fois qu’une touche est pressée. Utilisez la mise en cache dans la mesure du possible pour réduire la charge du serveur. La méthode Find (Trouver) permet de retourner une liste de jusqu’à huit objets correspondants.
Présentez la liste à l’utilisateur. Les champs de texte et de description montrent le contenu des résultats de recherche et doivent être concaténés, idéalement à l’aide du champ de surlignage pour que les parties appropriées soient mises en évidence. Si le champ Next (Prochain) contient la valeur Retrieve (Récupérer) pour l’article sélectionné, faire passer la valeur de l’identifiant à Retrieve (Récupérer). Sinon, effectuez une autre recherche, en entrant le numéro d’identification dans le paramètre LastId.
Retrieve (Récupérer)
La fonction Retrieve (Récupérer) retourne l’adresse formatée.
Les résultats obtenus sont une série de FieldGroups. Le champ commun est défini pour tous les pays. L’étiquette commune présente l’adresse dans la boîte et le style préférés pour le pays sélectionné. Au besoin, on peut utiliser ces champs pour établir la correspondance avec un site Web ou une application après avoir recueilli l’adresse.