royal mail tracking api

واجهة برمجة تطبيقات تتبع البريد الملكي

لتتمكن من تتبع العناصر من خلال API Royal Mail API ، ستحتاج إلى أن تكون حامل حساب Royal Mail واعتماد على الوصول إلى واجهة برمجة تطبيقات التتبع من خلال بوابة مطور البريد الملكي على https://developer.royalmail.net/

تثبيت

 composer require nomisoft/royal-mail-tracking-api

الاستخدام

ستحتاج إلى الرقم المرجعي للتتبع للعنصر الذي ترغب في استرداد تفاصيله وكذلك معرف العميل ، وسر العميل ومعرف التطبيق (كل ذلك متاح من بوابة مطور البريد الملكي)

ملخص عنصر واحد

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

الاستجابة التي تم إرجاعها هي صفيف يحتوي

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

عنصر واحد الكامل

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

الاستجابة التي تم إرجاعها هي صفيف متعدد الأبعاد. يحتوي كل تحديث لحالة التسليم على كائن DateTime والموقع والحالة

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

)

ملخصات عنصر متعددة

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

الاستجابة التي تم إرجاعها هي مجموعة متعددة الأبعاد مع الرقم المرجعي للتتبع كمفتاح. كل عنصر يحتوي

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

إثبات التسليم

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

الاستجابة التي تم إرجاعها هي صفيف يحتوي على كائن وقت البيانات واسم الشخص الذي وقع على الطرود

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

الأخطاء

يتم طرح استثناء RoyalMailException إذا تم استلام استجابة خطأ من API. سيؤدي استدعاء وظيفة getMessage () إلى إرجاع وصف خطأ Mail Royal. هناك أيضًا وظيفة getCause () إضافية ستعود قيمة حقل "السبب" الذي يتم إرجاعه بواسطة API

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

إذا تم تسليم العنصر منذ أكثر من 30 يومًا ، فقد ترى ما يلي المطبوعة من رمز العينة أعلاه

 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