Complétez les adresses pendant la saisie de vos clients et confirmez une
adresse avant d’y expédier.
GraphQL
Utilisez locationSuggest pour proposer des adresses complètes pendant la saisie d’un client, et locationValidate pour vérifier une adresse et la récupérer sous une forme normalisée. Lorsqu’une adresse est validée, vous pouvez transmettre le résultat à partyCreate ou partyCreateWorkflow afin que l’adresse soit enregistrée comme vérifiée.
Envoyez l’adresse partielle saisie par le client ainsi que le pays dans lequel effectuer la recherche. locationSuggest renvoie les adresses complètes correspondantes, dans le même format que l’entrée de localisation de partyCreate, ce qui vous permet de remplir le reste du formulaire d’adresse à partir de celle que le client sélectionne.
Le code ISO 3166-1 alpha-2 du pays dans lequel effectuer la recherche.
limit
Le nombre maximal de suggestions à renvoyer, de 1 à 20. Valeur par défaut : 10.
query
L’adresse partielle et libre saisie par le client, par exemple 22382 Avenida Emp.
Les suggestions constituent un point de départ, et non une adresse vérifiée. Validez l’adresse finalement retenue par le client avant de créer une partie avec celle-ci.
Envoyez l’adresse complète à locationValidate. Le résultat indique le niveau de vérification de l’adresse, l’adresse sous sa forme normalisée et un verificationToken lorsque l’adresse est vérifiée.
Le code de l’État, de la province ou de la région, par exemple CA.
countryCode
Le code ISO 3166-1 alpha-2 du pays.
line1
La première ligne de l’adresse.
line2 – line4
Lignes d’adresse supplémentaires, le cas échéant.
locality
La ville, la commune ou le village.
postalCode
Le code postal.
Envoyez autant d’éléments de l’adresse que possible. Un code postal, ou une localité accompagnée d’une division administrative, donne les meilleurs résultats.
Statuts de validation
Statut↕
Signification↕
Étape suivante suggérée↕
VERIFIED
L’adresse a été vérifiée jusqu’au bâtiment ou jusqu’à l’unité exacte.
Utilisez l’adresse normalisée.
PARTIALLY_VERIFIED
Seule une partie de l’adresse a été vérifiée, comme la rue ou la ville, mais pas le bâtiment.
Demandez au client de vérifier des détails comme le numéro de rue ou d’unité.
UNVERIFIED
L’adresse n’a pas pu être vérifiée. address vaut null.
Demandez au client de vérifier l’adresse.
L’adresse normalisée
Lorsque l’adresse est VERIFIED ou PARTIALLY_VERIFIED, address contient sa forme normalisée. Elle peut différer de ce que vous avez envoyé : des informations manquantes comme la ville peuvent être ajoutées, le code postal peut être complété, et les majuscules ainsi que les abréviations sont corrigées. Présentez l’adresse normalisée au client ou utilisez-la à la place de ce qu’il a saisi.
latitude et longitude sont incluses lorsqu’elles sont disponibles.
propertyType vaut RESIDENTIAL ou COMMERCIAL lorsque l’adresse est vérifiée et que son type est connu, et null dans le cas contraire. Il n’est pas appliqué automatiquement. Transmettez-le dans l’entrée de localisation lors de la création de la partie si vous souhaitez l’utiliser.
Un résultat VERIFIED inclut un verificationToken. Transmettez-le dans l’entrée location de partyCreate ou partyCreateWorkflow, avec l’adresse normalisée exactement telle que locationValidate l’a renvoyée. La localisation de la partie est alors enregistrée comme vérifiée, sans que l’adresse soit vérifiée à nouveau.
1mutationPartyCreate($input: PartyCreateInput!){
2 partyCreate(input:$input) {
3 id
4 type
5 location {
6 id
7 line1
8 locality
9 administrativeAreaCode
10 postalCode
11 countryCode
12 propertyType
13}
14}
15}
Gardez ces règles à l’esprit lorsque vous transmettez un jeton :
Un jeton est valable un jour. Un jeton expiré est ignoré, et la partie est tout de même créée.
Les champs d’adresse doivent correspondre à l’adresse normalisée. Si le client modifie l’adresse après l’avoir validée, le jeton est ignoré et la partie est tout de même créée. Validez l’adresse modifiée pour obtenir un nouveau jeton.
latitude, longitude, propertyType et metadata peuvent être modifiés sans affecter le jeton.
Traitez le jeton comme une valeur opaque. Ne l’analysez pas et ne le modifiez pas. Un jeton altéré, ou émis pour une autre organisation, fait échouer la requête.
Suggérer et valider des adresses
Suggérer et valider des adresses
Complétez les adresses pendant la saisie de vos clients et confirmez une adresse avant d’y expédier.
GraphQL
Utilisez
locationSuggestpour proposer des adresses complètes pendant la saisie d’un client, etlocationValidatepour vérifier une adresse et la récupérer sous une forme normalisée. Lorsqu’une adresse est validée, vous pouvez transmettre le résultat àpartyCreateoupartyCreateWorkflowafin que l’adresse soit enregistrée comme vérifiée.Suggérer des adresses pendant la saisie
Envoyez l’adresse partielle saisie par le client ainsi que le pays dans lequel effectuer la recherche.
locationSuggestrenvoie les adresses complètes correspondantes, dans le même format que l’entrée de localisation departyCreate, ce qui vous permet de remplir le reste du formulaire d’adresse à partir de celle que le client sélectionne.query LocationSuggest($input: LocationSuggestInput!) {locationSuggest(input: $input) {line1line2localityadministrativeAreaadministrativeAreaCodepostalCodecountryCodelatitudelongitude}}Champs d’entrée des suggestions
countryCodelimitquery22382 Avenida Emp.Les suggestions constituent un point de départ, et non une adresse vérifiée. Validez l’adresse finalement retenue par le client avant de créer une partie avec celle-ci.
Valider une adresse
Envoyez l’adresse complète à
locationValidate. Le résultat indique le niveau de vérification de l’adresse, l’adresse sous sa forme normalisée et unverificationTokenlorsque l’adresse est vérifiée.query LocationValidate($input: LocationValidateInput!) {locationValidate(input: $input) {statusverificationTokenaddress {line1line2localityadministrativeAreaadministrativeAreaCodepostalCodecountryCodelatitudelongitudepropertyType}}}Champs d’entrée de la validation
administrativeAreaadministrativeAreaCodeCA.countryCodeline1line2–line4localitypostalCodeEnvoyez autant d’éléments de l’adresse que possible. Un code postal, ou une localité accompagnée d’une division administrative, donne les meilleurs résultats.
Statuts de validation
VERIFIEDPARTIALLY_VERIFIEDUNVERIFIEDaddressvautnull.L’adresse normalisée
Lorsque l’adresse est
VERIFIEDouPARTIALLY_VERIFIED,addresscontient sa forme normalisée. Elle peut différer de ce que vous avez envoyé : des informations manquantes comme la ville peuvent être ajoutées, le code postal peut être complété, et les majuscules ainsi que les abréviations sont corrigées. Présentez l’adresse normalisée au client ou utilisez-la à la place de ce qu’il a saisi.latitudeetlongitudesont incluses lorsqu’elles sont disponibles.propertyTypevautRESIDENTIALouCOMMERCIALlorsque l’adresse est vérifiée et que son type est connu, etnulldans le cas contraire. Il n’est pas appliqué automatiquement. Transmettez-le dans l’entrée de localisation lors de la création de la partie si vous souhaitez l’utiliser.Enregistrer une adresse vérifiée sur une partie
Un résultat
VERIFIEDinclut unverificationToken. Transmettez-le dans l’entréelocationdepartyCreateoupartyCreateWorkflow, avec l’adresse normalisée exactement telle quelocationValidatel’a renvoyée. La localisation de la partie est alors enregistrée comme vérifiée, sans que l’adresse soit vérifiée à nouveau.mutation PartyCreate($input: PartyCreateInput!) {partyCreate(input: $input) {idtypelocation {idline1localityadministrativeAreaCodepostalCodecountryCodepropertyType}}}Gardez ces règles à l’esprit lorsque vous transmettez un jeton :
latitude,longitude,propertyTypeetmetadatapeuvent être modifiés sans affecter le jeton.Erreurs
Address verification is unavailableInvalid location verification tokenverificationTokena été altéré ou a été émis pour une autre organisation.locationValidatel’a renvoyé, ou omettez-le.limit must be between 1 and 20limittransmise àlocationSuggestétait hors de la plage autorisée.limitcomprise entre 1 et 20, ou omettez-la pour obtenir 10 suggestions.LocationSuggestInput LocationValidateInput PartyCreateInput PartyCreateWorkflowInput
partyCreate partyCreateWorkflow
Cette page vous a-t-elle été utile?