Programme pour développeurs

Prêt à rejoindre le Programme pour développeurs? Inscrivez-vous GRATUITE

Ressources

Tarification

Exemples de codes de tarification : Java (.zip) | PHP (.zip) | C# (.zip)

Découvrir les services – Module REST

Résumé

Nom :	Découvrir les services
Raison pour utiliser le service :	Pour découvrir la liste de services postaux pouvant être utilisés pour un pays de destination, un client, une convention ou un code postal d'origine ou de destination donnés.
Données d'entrée :	Pays de destination
Données de sortie :	Liens du service et descriptions
Historique des versions :	Notes de mise à jour

Découvrir les services – Résumé du service

Détails sur la demande

Structure de la demande pour découvrir les services

Point final

GET https://XX/rs/ship/service?country={code de pays}&contract={« contract-id »}&origpc={« origin-postal-code »}&destpc={« destination-postal-code »}
Remplacez...	Par...
XX (développement)	ct.soa-gw.canadapost.ca
XX (production)	soa-gw.canadapost.ca
{Code de pays}	le code de pays désiré
{contract-id}	Numéro de convention de PostesCanada

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.ship.rate-v4+xml (Remarque : / à la place de la valeur de l’en-tête affichera un message d’erreur)
Authorization	Basic {Encodage en base64 du code d'usager:mot de passe}
Accept-language	en-CA ou fr-CA

Corps du message

Aucun

Chaîne de requête

Si aucun paramètre de recherche n'est fourni, tous les services du régime intérieur, à destination des États-Unis et du régime international, accessibles sans convention seront indiqués dans la liste. Les paramètres suivants peuvent être fournis dans la demande pour améliorer la réponse.

Nom de l'élément	Optionnel ou requis	Description
country	Optionnel	Si l'élément «country-code» est fourni, seuls les services qui conviennent à l'expédition des articles au pays indiqué s'afficheront.
contract	Optionnel	Si l'élément «contrat-id» est fourni, la réponse comprendra également les services restreints accessibles grâce à cette convention.

Éléments de la demande

Les données d'entrée XML ne sont pas nécessaires pour le service Découvrir les services.

Détails de la réponse

Éléments de réponse

Le tableau suivant décrit les champs XML de la réponse.
Pour obtenir un aperçu détaillé de la hiérarchie de la réponse, veuillez consulter le diagramme ci-dessous.

Nom de l'élément	Type	Description
services	Complexe	Liste de services qui peuvent être utilisés pour les paramètres de requête précisés.
service	Complexe	Comprend les détails d'un service.
service-code	Simple	Code utilisé pour présenter une demande de service.
service-name	Simple	Nom du service dans la langue précisée.
link	Simple	Lien vers le service Obtenir les services (Consultez la section Points finaux fournis)

Réponse – Diagramme XML

Le diagramme suivant présente une réponse de niveau supérieur. La structure des services (réponse valide) ou la structure des messages (réponse d'erreur) s'affichera.

Diagramme de la réponse XML à la demande de service pour découvrir les services

Réponses d'erreur possibles

Les messages ci-dessous pourraient s'afficher si la valeur du paramètre de requête est inexacte.

Code	Description
2550	Le numéro de convention n'est pas valide.
7266	Le code postal doit respecter le format «A9A» ou «A9A9A9».
8534	Un pays de destination valide doit être indiqué.
9194	L'élément «origin-postal-code» doit également être fourni lorsque l'élément «destination-postal-code» est fourni.

Consultez la section Codes de statut HTTP pour obtenir des renseignements généraux concernant le traitement des erreurs.

Exemples

Exemple de demande REST

Get https://XX/rs/ship/service?country=JP
Accept: application/vnd.cpc.ship.rate-v4+xml

Exemple de réponse XML


  HTTP/1.1 200 OK

    Content-Type:application/vnd.cpc.ship.rate-v4+xml

    
    
                                                                                                                                        
       <service-code>INT.XP</service-code>

	  
        <service-name>Xpresspost International</service-name>

        <link rel="service" href="https://XX/rs/ship/service/INT.XP?country=JP" media-type="application/vnd.cpc.ship.rate-v4+xml"></link>

      
      </service>

      <service>
       <service-code>INT.SP.SURF</service-code>

        <service-name>Small Packet International Surface</service-name>

        <link rel="service" href="https://XX/rs/ship/service/INT.SP.SURF?country=JP" media-type="application/vnd.cpc.ship.rate-v4+xml"></link>

      
      </service>

      <service>
       <service-code>INT.SP.AIR</service-code>

        <service-name>Small Packet International Air</service-name>

        <link rel="service" href="https://XX/rs/ship/service/INT.SP.AIR?country=JP" media-type="application/vnd.cpc.ship.rate-v4+xml"></link>

      
      </service>

Ouvrir unesession