Expédition sans contrat
Obtenez des informations sur la clé publique des envois hors contrat – REST
Résumé
| Nom : | Obtenir des informations sur la clé publique des envois sans contrat |
|---|---|
| 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 un envoi sans contrat Obtenez une expédition sans contrat |
| Prochain appel typique : | N/A |
| Historique des versions : | Notes de version |
Détails de la demande
Demande – Structure pour obtenir des informations sur la clé publique d’expédition sans contrat
Point de terminaison
GET https://XX/rs/{mailed_by}/ncshipment/{shipment id}/qrCode |
|
|---|---|
Remplacer... |
Avec... |
XX (Development) |
ct.soa-gw.canadapost.ca |
XX (Production) |
soa-gw.canadapost.ca |
{mailed by customer} |
votre numéro de client * |
{shipment id} |
l'ID d'envoi approprié * |
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
|---|---|
Accept |
application/vnd.cpc.ncshipment-v4+xml (Note : */* à la place de la valeur d'en-tête renverra une erreur) |
Content-Type |
application/vnd.cpc.ncshipment-v4+xml (Note : */* à la place de la valeur d'en-tête renverra une erreur) |
Authorization |
Basic {Base64 encoding of userid:password} |
Accept-language |
en-CA or fr-CA |
Corps
Aucun
Demande – Éléments
Le service Obtenir des informations sur la clé publique des envois sans contrat ne nécessite aucune donnée XML d'entrée.
Détails de la réponse
Demande – Éléments
Le service Obtenir des informations sur la clé publique des envois sans contrat ne nécessite aucune donnée XML d'entrée.
| Obtenez des informations sur la clé publique des envois hors contrat – Détails de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
Non-contract-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) |
Response – XML Diagram
Le diagramme suivant montre la structure de niveau supérieur de la réponse XML à ce service.
Réponse – Réponses aux erreurs possibles
Aucune erreur n'est attendue pour l'appel de ce lien, mais vous recevrez une erreur 404 si vous appelez Obtenir des informations de clé publique d'expédition non contractuelle plus de 90 jours après la fourniture du lien.
Exemples
Exemple de requête XML REST
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
<non-contract-shipment-public-key-info xmlns="http://www.canadapost.ca/ws/ncshipment-v4">
<expiry-date>2023-08-18T23:59:59-04:00</expiry-date>
<url>https://stg12.canadapost-postescanada.ca/printlabel-imprimeretiquette?key-cle=328e7bfb331640a3bd1deabb07e9dd72</url>
<qr-code>/9j/4AAQSkZ...</qr-code>
</non-contract-shipment-public-key-info >
