Plates-formes de cybercommerce
Obtenir l'information sur l'inscription du commerçant – SOAP
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 de service
WSDL : | merchantregistration.wsdl |
---|---|
Point final (Conception) : | https://ct.soa-gw.canadapost.ca/ot/soap/merchant/registration/v2 |
Point final (Production) : | https://soa-gw.canadapost.ca/ot/soap/merchant/registratio/v2 |
Espace de nommage : | http://www.canadapost.ca/ws/soap/merchant/registration/v2 |
Opération : | GetMerchantRegistrationInfo |
La présente section décrit les éléments XML d'entrée pour ce service. Pour obtenir la structure hiérarchique, consultez le diagramme XML.
Obtenir l'information sur l'inscription du commerçant – Éléments de la demande | |||
---|---|---|---|
Nom de l'élément | Type | Requis/Optionnel | Description |
Get-merchant-registration-info-request |
complexe |
requis |
Élément XML de niveau supérieur de la structure de la réponse. |
locale |
simple |
optionnel |
Indique votre langue de préférence pour recevoir les messages d'erreur. EN = Anglais Si aucune valeur n'est fournie, la langue par défaut est « Anglais ». |
token-id |
simple |
requis |
Code numérique à 40 chiffres 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 Web « Obtenir le jeton d'inscription du commerçant » en plus d'entamer le procédé d'inscription du commerçant à l'aide du numéro d'identification du jeton. |
Demande – Diagramme XML
Détails de la réponse
Réponse – Éléments
Le tableau suivant décrit les éléments XML figurant dans la réponse. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.
Obtenir l'information sur l'inscription du commerçant – Éléments de la réponse | ||
---|---|---|
Nom de l'élément | Type | Description |
Get-merchant-registration- info-response |
Complexe |
Élément XML de niveau supérieur pour la structure de réponse. Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur. |
merchant-info |
Complexe |
Structure XML contenant les 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
Réponse – Réponses d'erreur possibles
La réponse à des conditions d'erreur pour ce service en ligne respecte l'approche standard SOAP liée à la réponse d'erreur, laquelle est utilisée pour tous les services en ligne de Postes Canada. Pour obtenir de plus amples renseignements, consultez la section portant sur le traitement des erreurs dans les Principes de base liés au module SOAP pour les services Web de Postes Canada.
Anomalies – Module SOAP
Voici les anomalies du module SOAP possibles pour ce service :
Code | Nom | Description |
---|---|---|
AA007 |
Plate-forme inactive |
Vous apercevrez cette erreur si vous avez essayé d'utiliser le service « Obtenir le jeton d'inscription du commerçant » lorsque votre demande d'inscription pour votre plate-forme de cybercommerce approuvée est toujours en attente avec Postes Canada. Vous ne pouvez pas utiliser ce service tant que Postes Canada n'a pas approuvé votre demande. |
AA008 |
Plate-forme non autorisée |
Vous apercevrez cette erreur si vous essayez d'utiliser le service « Obtenir le jeton d'inscription du |
Application – Message d'erreur
Voici un message d'erreur possible pour l'application :
<messages>
<message>
<code>9174</code>
<description> The specified token-id is either invalid or has expired.</description>
</message>
</messages>
Nota : Si un commerçant n'a pas terminé le procédé d'inscription et que le token-id était valide, les champs relatifs au merchant-username et au merchant-password seraient vides, mais aucun message d'erreur ne s'afficherait.
Exemples
Exemple de demande XML selon le module SOAP – Obtenir l'information sur l'inscription du commerçant
<get-merchant-registration-info-request>
<locale>EN</locale>
<token-id>520d5199226ebf93bccaa4</token-id>
</get-merchant-registration-info-request>
Exemple de réponse XML selon le module SOAP – Obtenir l'information sur l'inscription du commerçant
<get-merchant-registration-info-response>
<merchant-info>
<customer-number>0001234567</customer-number>
<contract-number>0040665287</contract-number>
<merchant-username>5394dfee1391b1ba</merchant-username>
<merchant-password>01b34a66d8bf0a13730a4e</merchant-password>
<has-default-credit-card>true</has-default-credit-card>
<has-default-supplier-account>true</has-default-supplier-account>
</merchant-info>
</get-merchant-registration-info-response>