Plates-formes de cybercommerce
Obtenir le jeton d'inscription du commerçant – Module REST
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 : | Aucune donnée d'entrée n'est nécessaire, mais seules les plates-formes de cybercommerce approuvées par Postes Canada peuvent avoir recours à ce service Web. |
| 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
Demande – Structure pour le service « Obtenir le jeton d'inscription du commerçant »
Point final
https://XX/ot/token |
|
|---|---|
| Remplacez... | Par... |
XX (Conception) |
ct.soa-gw.canadapost.ca |
XX (Production) |
soa-gw.canadapost.ca |
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 – Éléments
Les données d'entrée XML ne sont pas nécessaires pour ce service.
Détails de la réponse
Réponse – Éléments
| Obtenir le jeton d'inscription du commerçant – Éléments de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
token |
Complexe |
Élément XML de niveau supérieur pour la structure de réponse. |
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
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.
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 REST – Obtenir le jeton d'inscription du commerçant
https://XX/ot/token
Exemple de réponse XML selon le module REST – Obtenir le jeton d'inscription du commerçant
<token>
<token-id>34536456345353534535</token-id>
</token>
