royal mail tracking api

Royal Mail Tracking API

Untuk dapat melacak item melalui Royal Mail API, Anda harus menjadi pemegang akun Royal Mail dan telah menyetujui akses ke API pelacakan melalui portal pengembang Royal Mail di https://developer.royalmail.net/

Instalasi

 composer require nomisoft/royal-mail-tracking-api

Penggunaan

Anda akan memerlukan nomor referensi pelacakan dari item yang ingin Anda ambil detail serta ID klien, rahasia klien, dan ID aplikasi Anda (semuanya tersedia dari portal pengembang Royal Mail)

Ringkasan Item Tunggal

 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 ();
}

Respons yang dikembalikan adalah array yang berisi objek datetime, status dan teks ringkasan

 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 .
)

Sejarah lengkap item tunggal

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

Respons yang dikembalikan adalah array multidimensi. Setiap pembaruan status pengiriman berisi objek datetime, lokasi dan status

 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.
        )

)

Beberapa ringkasan item

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

Respons yang dikembalikan adalah susunan multidimensi dengan nomor referensi pelacakan sebagai kunci. Setiap item berisi objek datetime, status dan ringkasan

 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.
        )
)

Bukti pengiriman

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

Respons yang dikembalikan adalah array yang berisi objek datetime dan nama orang yang menandatangani kontrak untuk parsel

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

Kesalahan

Pengecualian RoyalMailException dilemparkan jika respons kesalahan diterima dari API. Memanggil fungsi getMessage () akan mengembalikan deskripsi kesalahan Royal Mail. Ada juga fungsi tambahan getCause () yang akan mengembalikan nilai bidang 'penyebab' yang dikembalikan oleh API

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

Jika item dikirim lebih dari 30 hari yang lalu, Anda mungkin melihat yang berikut dicetak dari kode sampel di atas

 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