Programme pour développeurs

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

Ressources

Repérage

Exemples de codes de repérage : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir le certificat de confirmation de livraison – Module REST

Résumé

Nom :	Obtenir le certificat de confirmation de livraison
Raison pour utiliser le service :	Pour récupérer l'image du certificat de confirmation de livraison (qui est un document présentant une preuve de livraison avec détails) pour un colis donné.
Données d'entrée :	NIP
Données de sortie :	Document PDF
Exemples d'erreurs :	NIP introuvable, signature non disponible
Appels précédents habituels :	Obtenir un résumé du repérage, Obtenir les détails de suivi
Prochain appel habituel :	Aucun appel directement lié
Historique des versions :	Notes de mise à jour

Détails sur la demande

Structure de la demande pour obtenir le certificat de confirmation de livraison

Point final

GET https://XX/vis/certificate/{numéro d'identification du produit}
Remplacez...	Par...
XX (développement)	ct.soa-gw.canadapost.ca
XX (production)	soa-gw.canadapost.ca
{numéro d'identification du produit}	le numéro d'identification du produit (NIP)

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.track-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

Corps du message

Aucun

Éléments de la demande

Le NIP est le seul paramètre requis pour ce service, tel qu'il est indiqué ci-dessous.

Obtenir le certificat de confirmation de livraison – REST – paramètres de la demande

Nom du paramètre Type de paramètre Description/Taille/Format

Obtenir le certificat de confirmation de livraison – REST – paramètres de la demande
Nom du paramètre	Type de paramètre	Description/Taille/Format
Accès avec le NIP
{pin number}	Intégré directement au URI	Le numéro d'identification du produit (NIP) est attribué par Postes Canada au cours de la création de l'étiquette d'expédition et utilisé aux fins de repérage. (12, 13 ou 16 caractères) Lorsque vous exécutez une demande avec le NIP, il est obligatoire et il s'agit du seul paramètre nécessaire. Le `{numéro d'identification du produit}` est intégré aux URI comme suit : `XX/vis/certificate/{numéro d'identification du produit}`

Accès avec le NIP

{pin number}

Intégré directement au URI

Le numéro d'identification du produit (NIP) est attribué par Postes Canada au cours de la création de l'étiquette d'expédition et utilisé aux fins de repérage.

(12, 13 ou 16 caractères)

Lorsque vous exécutez une demande avec le NIP, il est obligatoire et il s'agit du seul paramètre nécessaire.

Le {numéro d'identification du produit} est intégré aux URI comme suit :

XX/vis/certificate/{numéro d'identification du produit}

Réponses d'erreur possibles

Une demande bien structurée peut recevoir la réponse d'erreur d'application suivante :

Code	Message
007	Aucune donnée de livraison n'est disponible

Détails de la réponse

Éléments de réponse

Seuls les types simples sont présentés dans le tableau ci-dessous. Pour les types complexes, se reporter au diagramme.

Obtenir le certificat de confirmation de livraison – REST – éléments de réponse
Nom de l'élément	Description
delivery-confirmation-certificate	L'élément du niveau supérieur de la structure XML de la réponse.
filename	Un nom de fichier possible à utiliser en fonction du NIP.
image	La chaîne d'octets codée en base64 pour le fichier.
mime-type	application/pdf

Diagramme XML de la réponse

La réponse comprendra le certificat de confirmation de livraison ou la structure des messages.

Diagramme XML pour la réponse de l'option Obtenir le certificat de confirmation de livraison

Exemples

Demande à l'option Obtenir le certificat de confirmation de livraison

GET https://XX/vis/certificate/1847430072172051

Réponse de l'option Obtenir le certificat de confirmation de livraison


  
  
 <delivery-confirmation-certificate>

     <filename>1371134583769923.jpg</filename>

      <image>/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGB
      gcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICI
      sIxwcKDcpLDAHIYIUESDFSKVIOWVHDVHKSDJHVSDNVSFDMVN
      SDVNSDJVSDSWEHDVKJKJWE/wAARCABfAZADASIAAhEBAxEB8
      QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoLAtRAA
      AgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBka
      </image>

      <mime-type>image/jpg</mime-type>

    
    </delivery-confirmation-certificate>

Ouvrir unesession