Plates-formes de cybercommerce
Obtenir l'information sur l'inscription du commerçant – Module REST
Résumé
| Nom : | Obtenir l'information sur l'inscription du commerçant |
|---|---|
| Raison pour utiliser le service : | Une demande de plate-forme de cybercommerce est envoyée lorsque le commerçant a terminé le procédé d'inscription de Postes Canada. Cette demande affiche les données du commerçant, notamment son numéro de client ainsi que son code d'usager et son mot de passe. Ces renseignements sont nécessaires afin que la plate-forme puisse effectuer les transactions d'expédition du service Web pour le commerçant. |
| Données d'entrée : | Numéro d'identification du jeton d'inscription (token-id). |
| Données de sortie : | Numéro de client, clé API (code d'usager et mot de passe) et convention (le cas échéant) du commerçant. |
| Exemples d'erreurs : | Numéro d'identification de jeton invalide. |
| Demande de service précédente habituelle : | Obtenir le jeton d'inscription du commerçant |
| Historique des versions : |
Détails sur la demande
Demande – Structure pour le service « Obtenir l'information sur l'inscription du commerçant »
Point final
GET https://XX/ot/token/{token-id} |
|
|---|---|
| Remplacez... | Par... |
XX (Conception) |
ct.soa-gw.canadapost.ca |
XX (Production) |
soa-gw.canadapost.ca |
{token-id} |
Numéro d'identification du jeton d'inscription |
Variable des en-têtes HTTP |
Valeur |
|---|---|
Accept |
application/vnd.cpc.registration-v2+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Content-Type |
application/vnd.cpc.registration-v2+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Authorization |
Basic {Encodage base64 du code d'usager:mot de passe} |
Accept-language |
en-CA ou fr-CA |
Aucun
Demande – Paramètres de requête
Le numéro d'identification du jeton d'inscription est le seul paramètre requis pour ce service.
| Obtenir l'information sur l'inscription du commerçant – Paramètres de requête de la demande | ||
|---|---|---|
| Nom du paramètre de requête | Type de paramètre |
Description |
{token-id} |
Intégré directement |
{Code numérique à 40 chiffres} Il est intégré au URI pour présenter une demande de service. Il s'agit du numéro d'identification de jeton unique attribué par Postes Canada au commerçant. La plate-forme doit récupérer le numéro d'identification du jeton par l'entremise du service |
Détails de la réponse
Réponse – Éléments
| Obtenir l'information sur l'inscription du commerçant – Éléments de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
merchant-info |
Complexe |
Élément XML de niveau supérieur pour la structure de réponse. Correspond aux renseignements sur le commerçant. Remarque : Dans l’environnement « Bac à sable », les renseignements relatifs au client test générique sont renvoyés. Pour mettre à l’essai les services du Programme pour développeurs en tant que commerçant particulier, utilisez la clé API de production de ce dernier dans l’environnement « Bac à sable ». Cette clé est valide dans les deux environnements. |
customer-number |
Simple |
Numéro de client du commerçant. Les numéros de client comptent 10 chiffres. Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début. |
contract-number |
Simple |
Il s'agit du numéro de convention du commerçant s'il n'a qu'une seule convention. Si le commerçant n'a pas de convention ou qu'il en a plusieurs, aucun numéro de convention ne s'affichera. Les numéros de convention comptent 10 chiffres. Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début. |
merchant-username |
Simple |
Code d'usager faisant partie de la clé API du commerçant. |
merchant-password |
Simple |
Mot de passe faisant partie de la clé API du commerçant. |
has-default-credit-card |
Simple |
{vrai, faux} Indique si le commerçant a une carte de crédit par défaut en dossier avec Postes Canada qui peut être utilisée pour les transactions d'expédition. Si la valeur est « Vrai », le commerçant peut effectuer ses transactions d'expédition sans convention et facturer ses envois sur la carte de crédit. Si cette valeur et l’élément has-default-supplier-account indiquent « Faux », le commerçant ne peut pas effectuer ses transactions d’expédition sans convention. |
has-default-supplier-account |
Simple |
{true,false} Indique si le commerçant a un compte de tiers par défaut figurant dans les dossiers de Postes Canada pouvant être utilisé pour les transactions d’expédition. Si la valeur indique « Vrai », le commerçant peut effectuer ses transactions d’expédition à l’aide de cette méthode de paiement. Si cette valeur et l’élément has-default-credit-card indiquent « Faux », le commerçant ne peut pas effectuer ses transactions d’expédition sans convention. Remarque : Le compte de fournisseur comme mode de paiement est exclusivement réservé aux fournisseurs. |
Réponse – Diagramme XML
Obtenir l'information sur l'inscription du commerçant – Structure de la réponse XML
Réponse – Réponses d'erreur possibles
Dans le cas d'une erreur d'application, une réponse d'erreur (code de statut HTTP de niveau 400) sera générée et le corps du message XML aura une structure du message d'erreur plutôt qu'une réponse de réussite. Pour obtenir de plus amples renseignements, veuillez consulter la section Codes de statut HTTP.
Exemples
Exemple de demande XML selon le module REST – Obtenir l'information sur l'inscription du commerçant
GET https://XX/ot/token/123435566
Exemple de réponse XML selon le module REST – Obtenir l'information sur l'inscription du commerçant
<merchant-info>
<customer-number>1234567890</customer-number>
<contract-number>1234567890-</contract-number>
<merchant-wsid>1234567890123456</merchant-wsid>
<merchant-password>12343567890123456789012</merchant-password>
<has-default-credit-card>false</has-default-credit-card>
<has-default-supplier-account>true</has-default-supplier-account>
<merchant-info>
