Plates-formes de cybercommerce
Obtenir le jeton d'inscription du commerçant – SOAP
Résumé
| Nom : | Obtenir le jeton d'inscription du commerçant |
|---|---|
| Raison pour utiliser le service : | Pour obtenir un jeton d'inscription unique qui est utilisé par le commerçant pour entamer le procédé d'inscription de Postes Canada. Remarque : Vous n’avez pas besoin d’inscrire de nouveau un commerçant à l’environnement « Bac à sable » (développement); sa clé API de production est valide pour les deux environnements. Pour effectuer un essai en tant que commerçant générique, utilisez le numéro de client 2004381 et le numéro de convention 42708517. |
| Données d'entrée : | Langue privilégiée pour les messages d'erreur. |
| Données de sortie : | Numéro d'identification du jeton utilisé pour inscrire un commerçant aux services de Postes Canada. |
| Exemples d'erreurs : | Plate-forme ne pouvant pas faire appel à ce service Web. |
| 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/registration/v2 |
| Espace de nommage : | http://www.canadapost.ca/ws/soap/merchant/registration/v2 |
| Opération : | GetMerchantRegistrationToken |
La présente section décrit les éléments XML d'entrée pour ce service.
| Obtenir le jeton d'inscription du commerçant – Éléments de la demande | |||
|---|---|---|---|
| Nom de l'élément | Type | Requis/Optionnel | Description |
get-merchant-registration-token-request |
complexe |
requis |
Élément XML de niveau supérieur pour la demande. |
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 ». |
Demande – Diagramme XML
Obtenir le jeton d'inscription du commerçant – Structure de la demande 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 le jeton d'inscription du commerçant – Éléments de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
get-merchant-registration-token-response |
Complexe |
Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse. Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur. |
token |
Complexe |
Cette structure contient les résultats liés à l'exécution réussie du service. |
token-id |
Simple |
Numéro d'identification de jeton unique utilisé par le commerçant pour entamer le procédé d'inscription de Postes Canada. La même valeur figée (1111111111111111) est toujours renvoyée dans l’environnement « Bac à sable » (développement). |
Réponse – Diagramme XML
Obtenir le jeton d'inscription du commerçant – Structure de la réponse 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.
Les messages d'erreur possibles pour ce service sont les suivants :
| 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 |
Exemples
Exemple de demande XML selon le module SOAP – Obtenir le jeton d'inscription du commerçant
<get-merchant-registration-token-request>
<locale>EN</locale>
</get-merchant-registration-token-request>
Exemple de réponse XML selon le module SOAP – Obtenir le jeton d'inscription du commerçant
<get-merchant-registration-token-response>
<token>
<token-id>520d5199226ebf93bccaa4</token-id>
</token>
</get-merchant-registration-token-response>
