Expédition sous contrat

Exemples de codes pour l'expédition avec convention : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir les informations sur la clé publique de l'expédition – REST

Résumé

Nom :	Obtenir les informations sur la clé publique de l'expédition
Raison d'appeler :	Pour récupérer les détails de la clé publique, notamment la date d'expiration, le code QR, l'URL publique (URL non authentifiée)
Saisir :	REST : appelle le lien renvoyé par un appel précédent. SOAP : invoquez l'opération pour obtenir les informations sur la clé publique.
Sortir :	La clé publique comprenant la date d'expiration, le code QR, l'URL publique (URL non authentifiée)
Exemples d'erreurs :	404 - Pas trouvé
Appel préalable typique :	Créer l'envoi Obtenir l'expédition
Prochain appel typique :	N/A
Historique des versions :	Notes de version

Obtenir les informations sur la clé publique de l'expédition – Résumé du service

Détails de la demande

Demande – Structure pour obtenir des informations sur la clé publique de l’expédition

Point de terminaison

Appelez le lien à partir de l'un de ces appels précédents : Créer un envoi où rel="publicKeyInfo" (voir Points de terminaison fournis)

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accepter	à partir du type de média dans le lien d'origine (Remarque : / à la place de la valeur d'en-tête renverra une erreur)
Autorisation	Basique {Base64 encodage de userid:password}
Accepter la langue	en-CA ou fr-CA

Corps

Aucun

Demande – Éléments

Le service Obtenir les informations sur la clé publique de l'expédition ne nécessite aucune donnée XML d'entrée.

Détails de la réponse

Réponse – Éléments

Obtenir les informations sur la clé publique de l'expédition - Détails de la réponse
Nom de l'élément	Taper	Description
shipment-public-key-info	Complexe	Il s'agit du niveau supérieur de la structure XML.
expiry-date	Simple	Indique quand l'URL publique est valide jusqu'à
url	Simple	Fournit une URL non authentifiée à l'étiquette
qr-code	Simple	Il encode l'URL publique (encodage base64)

Diagramme XML de réponse

Obtenir le diagramme XML de réponse aux informations sur la clé publique de l'expédition (REST)

View full-size image

Réponse – Réponses aux erreurs possibles

Aucune erreur n'est attendue lors de l'invocation de ce lien, mais vous recevrez une erreur 404 si vous invoquez Get Shipment Public Key Info plus de 90 jours après la fourniture du lien.

Exemples

Exemple de demande XML REST – Obtenir des informations sur la clé publique de l'expédition


  GET https://XX/rs/12341234/123456789/shipment/123456789012345678/qrCode

	Accept:application/vnd.cpc.shipment-v8+xml

	Authorization:Basic s7HD7gwsennesc==

Exemple de réponse XML REST – Obtenir des informations sur la clé publique de l'expédition


  
    

    <shipment-public-key-info xmlns="http://www.canadapost.ca/ws/shipment-v8">

        
            <expiry-date>2024-01-15T23:59:59-05:00</expiry-date>

            <url>https://canadapost-postescanada.ca/printlabel-imprimeretiquette?key-cle=c105151641f343cf9fa32ee519b439d2</url>

            <qr-code>/9j/4AA...</qr-code>
     </shipment-public-key-info>

Ouvrir unesession

Ressources