Avec l'API ShippyPro CheckAddress, vous pouvez vérifier et valider automatiquement les adresses d'expédition pour plus de 240 pays – avec un seul appel pour tous vos Transporteurs.
💡Vérifier les adresses d'expédition vous permet de réduire :
les erreurs pendant le processus d'expédition et de gagner du temps dans les opérations ;
les exceptions d'expédition et offrir aux clients la meilleure expérience d'expédition ;
le coût du stock d'expédition du Transporteur, dans le cas d'adresses non distribuables.
Dans cet article, vous apprendrez comment fonctionne l'API CheckAddress, comment interpréter les réponses et voir quelques exemples.
Table des matières
Exigences
Comment fonctionne la validation
Ignorer la validation côté Transporteur
Réponses
Exemples
Valider une adresse avec un Transporteur générique
Valider une adresse avec un Transporteur qui la supporte
Valider des adresses internationales (TBC)
1. Exigences
Si vous êtes novice dans la configuration de l'API ShippyPro, veuillez vous référer à la section de démarrage de la documentation de l'API ShippyPro. Vous devez générer une ApiKey pour vous authentifier avec l'API ShippyPro.
Pour utiliser l'API CheckAddress, vous devez avoir au moins un Transporteur connecté à votre compte ShippyPro pour envoyer les paramètres ShippyPro requis comme CarrierID et CarrierName. Si vous avez besoin d'obtenir le nom et l'ID de votre transporteur, veuillez vous rendre au bas de la page des Clés API de votre compte ShippyPro.
Cette API est capable de reconstituer une adresse en essayant de deviner des éléments d'une adresse erronée. Par exemple, si la réponse renvoie une précision de 95 %, cela fait référence aux indices renvoyés et provient de l'API de Google (ou de l'API du transporteur - voir la liste ci-dessus). La réponse ne peut jamais être exacte à 100 % car le système ne peut jamais être totalement sûr que les nouvelles informations correctes correspondent à ce que l'utilisateur souhaitait. Plus l'API est incertaine, plus le pourcentage d'exactitude de la nouvelle adresse est faible.
2. Comment fonctionne la validation
L'API CheckAddress fournit des validations d'adresse côté Transporteur et par GéoCodage. Si le Transporteur l'active, la validation est effectuée par le Transporteur, sinon, la validation de l'adresse se fera par GéoCodage.
Les transporteurs qui prennent actuellement en charge la validation des adresses via leur service web sont UPS (États-Unis et Porto Rico), MyDHL, TNT et GLS Italy. Dans les deux cas, un champ de précision est également fourni pour vérifier l'exactitude de l'adresse saisie.
Ignorer la validation côté Transporteur
Vous pouvez ignorer la validation de l'adresse côté Transporteur en définissant Générique comme paramètres du Transporteur. Consultez ici si vous avez besoin d'aide pour configurer le transporteur générique ShippyPro.
3. Réponses
Pour chaque adresse validée, vous pouvez obtenir les éléments suivants en réponse :
Messages de validation d'adresse : Ils peuvent être renvoyés (s'ils sont présents) par la réponse des transporteur API et par GéoCodage.
Suggestions d'adresses : Elles peuvent être renvoyées (si elles sont présentes) seulement par la réponse des transporteurs API, et non par GéoCodage.
Nouvelle Adresse : Elle est composée en remplaçant les champs signalés comme incorrects dans l'adresse initiale avec les nouvelles valeurs suggérées.
Précision : C'est un champ calculé par l'API CheckAddress qui est basé sur le GéoCodage. Il représente la précision de l'adresse.
4. Exemples d'appels
Vous pouvez trouver ici quelques exemples d'appels Check Address. Veuillez vous référer à votre documentation API pour en savoir plus sur les paramètres de demande et de réponse de l'API CheckAddress.
Valider une adresse avec un Transporteur Générique
a. Voici un exemple de demande JSON avec une adresse valide :
{
"Method": "CheckAddress",
"Params": {
"CarrierName": "Generic",
"CarrierID": 2928,
"Address": {
"street1": "Piazza della Calza 1",
"street2": "",
"city": "Firenze",
"state": "FI",
"zip": "50125",
"country": "IT"
},
"FromAddress": {
"country": "IT"
}
}
}Exemple de réponse :
{
"Result": "OK"
}
b. Voici un exemple de demande JSON avec une mauvaise adresse :
{
"Method": "CheckAddress",
"Params": {
"CarrierName": "Generic",
"CarrierID": 2928,
"Address": {
"street1": "Calza 1",
"street2": "",
"city": "Firenza",
"state": "FI",
"zip": "5010",
"country": "IT"
},
"FromAddress": {
"country": "IT"
}
}
}Exemple de réponse :
{
"Result": "NOK",
"Message": [
"Wrong address. Should be: Piazza della Calza 1",
"Wrong zip. Should be: 50125",
"Wrong city. Should be: Firenze"
],
"Suggestions": [],
"NewAddress": {
"street1": "Piazza della Calza 1",
"street2": "",
"city": "Firenze",
"state": "FI",
"zip": "50125",
"country": "IT"
},
"Accuracy": 95
}
Valider une adresse avec une Transporteur qui supporte la validation d'adresse
a. Voici un exemple de demande JSON avec une mauvaise adresse :
{
"Method": "CheckAddress",
"Params": {
"CarrierName": "UPS",
"CarrierID": 8003,
"Address": {
"street1": "Calza 1",
"street2": "",
"city": "Firenza",
"state": "FI",
"zip": "5010",
"country": "IT"
},
"FromAddress": {
"country": "IT"
}
}
}
Exemple de réponse :
{
"Result": "NOK",
"Message": [
"The request is not well formed",
"Wrong address. Should be: Piazza della Calza 1",
"Wrong zip. Should be: 50125",
"Wrong city. Should be: Firenze"
],
"Suggestions": [],
"NewAddress": {
"street1": "Piazza della Calza 1",
"street2": "",
"city": "Firenze",
"state": "FI",
"zip": "50125",
"country": "IT"
},
"Accuracy": 95
}
Valider des adresses internationales (TBC)
L'API Check Address supporte les adresses internationales, y compris les adresses russes et asiatiques. Veuillez noter que le format d'adresse peut varier d'un pays à l'autre et que des règles spécifiques peuvent s'appliquer à ces adresses et aux paramètres d'adresse à remplir.
Veuillez vérifier et tester les résultats de validation d'adresse avant de commencer à expédier.