Ajouter une adresse à un profil
POST /customervault/v1/profiles/profile_id/addresses
Voir notre documentation API complète pour une description intégrale des paramètres requis pour la requête de création d’adresse.
Dans l’exemple précédent, vous avez créé un profil pour un client. En conséquence, l’API a renvoyé un identifiant de profil représentant ce profil.
L’API Coffre-fort client vous permet d’ajouter plusieurs adresses au profil de votre client. Pour ajouter une adresse au profil, vous devez utiliser l’identifiant du profil et envoyer une requête POST au point de terminaison des adresses du profil concerné.
curl -X POST https://api.test.paysafe.com/customervault/v1/profiles/716adb4f-6b85-4089-ba9c-d9c0eb649cd7/addresses \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H ’Content-Type: application/json’ \
-d ’ {
"nickName":"home",
"street" : "100 Queen Street West",
"city" : "Toronto",
"state" : "ON",
"country" : "CA",
"zip" : "M5H 2N2"
}'
| Élément | Type | Requis? | Description |
|---|---|---|---|
| city | string | Oui | Il s’agit de la ville du client. |
| country | string length=2 | Oui | Il s’agit du pays du client. |
| defaultShippingAddressIndicator | boolean | Non | Il s’agit d’un indicateur que cette adresse est l’adresse de livraison par défaut. |
| nickName | string | Non | Il s’agit d’un alias pour cette adresse défini par le client, p. ex. « adresse personnelle ». |
| phone | string length<=40 | Non | Il s’agit du numéro de téléphone du destinataire. |
| recipientName | string length<=255 | Non | Il s’agit du nom du bénéficiaire à cette adresse, s’il est différent du nom figurant dans le profil. |
| state | string length<=40 | Non | Il s’agit de l’état, de la province ou de la région du client. |
| street | string length<=50 | Oui | Il s’agit de la première ligne de l’adresse du client. |
| street2 | string length<=50 | Non | Il s’agit de la deuxième ligne de l’adresse du client. |
| zip | string length<=10 | Oui | Il s’agit du code zip/postal du client. |
{
"id" : "81ffcddf-ad82-40d2-aaa0-c4f9c376ad65",
"status" : "ACTIVE",
"street" : "100 Queen Street West",
"city" : "Toronto",
"state" : "ON",
"country" : "CA",
"zip" : "M5H 2N2",
"defaultShippingAddressIndicator" : false
}
La réponse contient tous les détails soumis dans la requête, ainsi que l’identifiant de l’adresse. Notez l’identifiant pour une utilisation ultérieure.
| Element | Type | Description |
|---|---|---|
| id | string length<=36 | Il s’agit de l’identifiant de l’adresse. |
| status | enum | Il s’agit de l’état de la requête d’adresse : ACTIF |
Vous pouvez consulter le profil et l’adresse associée à l’aide d’une requête GET comme suit :
GET /customervault/v1/profiles/profile_id?fields=cards,addresses
Le paramètre fields est une liste de sous-composants à renvoyer, séparés par des virgules. Voir notre rubrique Référence API pour de plus amples renseignements.