royal mail tracking api

API de suivi du courrier royal

Pour pouvoir suivre les articles via l'API Royal Mail, vous devrez être un détenteur du compte Royal Mail et avoir approuvé l'accès à l'API de suivi via le portail du développeur Royal Mail à https://developer.royalmail.net/

Installation

 composer require nomisoft/royal-mail-tracking-api

Usage

Vous aurez besoin du numéro de référence de suivi de l'article que vous souhaitez récupérer les détails ainsi que votre ID client, le secret du client et l'ID d'application (tous disponibles sur le portail du développeur Royal Mail)

Résumé de l'article unique

 use  Nomisoft  RoyalMailTrackingApi  RoyalMail ;
use  Nomisoft  RoyalMailTrackingApi  RoyalMailException ;

$ rm = RoyalMail :: init ( ' CLIENT_ID ' , ' CLIENT_SECRET ' , ' APP_ID ' );
try {
    $ response = $ rm -> getSingleItemSummary ( ' XX12345678XX ' );
} catch ( SoapFault $ e ) {
	echo $ e -> getMessage ();
} catch ( RoyalMailException $ e ) {
	echo $ e -> getMessage () . ' - ' . $ e -> getCause ();
}

La réponse renvoyée est un tableau contenant un objet DateTime, l'état et le texte sommaire

 Array
(
    [datetime] => DateTime Object
        (
            [date] => 2016 - 06 - 01 12 : 30 : 00
            [timezone_type] => 3
            [timezone] => Europe / London
        )
    [status] => Delivered
    [summary] => Item XX12345678XX was collected and signed for by the addressee on the 2016 - 06 - 01 from Kidderminster DO .
)

Histoire complète de l'article unique

 use  Nomisoft  RoyalMailTrackingApi  RoyalMail ;
$ rm = RoyalMail :: init ( ' CLIENT_ID ' , ' CLIENT_SECRET ' , ' APP_ID ' );
$ response = $ rm -> getSingleItemHistory ( ' XX12345678XX ' );

La réponse renvoyée est un tableau multidimensionnel. Chaque mise à jour d'état de livraison contient un objet DateTime, l'emplacement et l'état

 Array
(
    [ 0 ] => Array
        (
            [datetime] => DateTime Object
                (
                    [date] => 2016 - 06 - 01 12 : 30 : 00
                    [timezone_type] => 3
                    [timezone] => Europe / London
                )
            [location] => Kidderminster DO
            [status] => Delivered
        )

    [ 1 ] => Array
        (
            [datetime] => DateTime Object
                (
                    [date] => 2016 - 05 - 31 15 : 30 : 00
                    [timezone_type] => 3
                    [timezone] => Europe / London
                )
            [location] => Kidderminster DO
            [status] => We have your item
        )

    [ 2 ] => Array
        (
            [datetime] => DateTime Object
                (
                    [date] => 2016 - 05 - 31 12 : 30 : 00
                    [timezone_type] => 3
                    [timezone] => Europe / London
                )
            [location] => Kidderminster DO
            [status] => Delivery attempted
        )

    [ 3 ] => Array
        (
            [datetime] => DateTime Object
                (
                    [date] => 2016 - 05 - 28 10 : 00 : 00
                    [timezone_type] => 3
                    [timezone] => Europe / London
                )
            [location] => Medway Mail Centre
            [status] => It 's on its way.
        )

)

Résumé des éléments multiples

 use  Nomisoft  RoyalMailTrackingApi  RoyalMail ;
$ rm = RoyalMail :: init ( ' CLIENT_ID ' , ' CLIENT_SECRET ' , ' APP_ID ' );
$ response = $ rm -> getMultiItemSummary ( array ( ' XX12345678XX ' , ' ZZ12345678ZZ ' ));

La réponse renvoyée est un tableau multidimensionnel avec le numéro de référence de suivi comme clé. Chaque élément contient un objet DateTime, un statut et le résumé

 Array
(
    [ XX12345678XX ] => Array
        (
            [datetime] => DateTime Object
                (
                    [date] => 2016 - 06 - 01 12 : 30 : 00
                    [timezone_type] => 3
                    [timezone] => Europe / London
                )
            [status] => Delivered
            [summary] => Item XX12345678XX was collected and signed for by the addressee on the 2016 - 06 - 01 from Kidderminster DO .
        )

    [ ZZ12345678ZZ ] => Array
        (
            [datetime] => DateTime Object
                (
                    [date] => 2016 - 06 - 01 12 : 30 : 00
                    [timezone_type] => 3
                    [timezone] => Europe / London
                )
            [status] => Delivered
            [summary] => We have a record of item ZZ12345678ZZ as being delivered from Fort William DO on 2016 - 06 - 01.
        )
)

Preuve de livraison

 use  Nomisoft  RoyalMailTrackingApi  RoyalMail ;
$ rm = RoyalMail :: init ( ' CLIENT_ID ' , ' CLIENT_SECRET ' , ' APP_ID ' );
$ response = $ rm -> getProofOfDelivery ( ' XX12345678XX ' );

La réponse renvoyée est un tableau contenant un objet DateTime et le nom de la personne qui a signé pour le colis

 Array
(
    [datetime] => DateTime Object
        (
            [date] => 2016 - 06 - 01 12 : 30 : 00
            [timezone_type] => 3
            [timezone] => Europe / London
        )
    [name] => Smith
)

Erreurs

Une exception RoyalMailexception est lancée si une réponse d'erreur est reçue de l'API. L'appel de la fonction getMessage () renverra la description de l'erreur du Royal Mail. Il existe également une fonction GetCause () supplémentaire qui renverra la valeur du champ «Cause» renvoyé par l'API

 try {
    $ response = $ rm -> getSingleItemSummary ( ' XX12345678XX ' );
} catch ( RoyalMailException $ e ) {
	echo $ e -> getMessage ();
	echo $ e -> getCause ();
}

Si l'article a été livré il y a plus de 30 jours, vous pourriez voir le code imprimé suivant à partir de l'exemple de code ci-dessus

 Tracking data are not available for barcode reference XX12345678XX
It is not possible to provide information about events that occurred more than 30 days ago