واجهة برمجة تطبيقات Correios مع PHP v2.0

متطلبات

الملحن
بي إتش بي >= 8.2

الحزم

luannsr12/sdkcorreios

تغطي واجهة برمجة التطبيقات هذه الخدمات التالية:

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

كيفية استخدام API

فيما يلي تعليمات الاستخدام:

 git clone https://github.com/luannsr12/api-correios/
 cd api-correios
 composer install

بعد التنزيل والتثبيت، قم بتحرير ملف "config.php" وأضف رمز الوصول الخاص بالتطبيق الخاص بك. يجب تمرير رمز الوصول هذا في رأس طلبات واجهة برمجة التطبيقات.

جميع نقاط النهاية

تتبع الطلب

نقطة النهاية: /correios/تتبع/
الطريقة: مشاركة

تجعيد الشعر:

curl --location --request GET '{{base_url}}/correios/tracking' 
--header 'Access-token: SEU_ACCESS_TOKEN' 
--header 'Content-Type: application/json' 
--data '{
  "objects": ["QQ588651634BR"],
  "provider": "Muambator"
}'

جسم:

المزود اختياري. بشكل افتراضي، يكون موقع البحث هو Best Tracking، راجع وثائق SDK لمعرفة الموفرين: Sdk Correios

 { "الكائنات": ["QQ588651634BR"]، "المزود": "Muambator"}

إجابة:

 {"النجاح": صحيح،"النتيجة": [
        {"code": "QQ588651634BR"، "status": "MOVEMENT"، "service_provider": "api.melhorrastreio.com.br"، "data": [
                {"date": "03-09-2024 07:27:10"، "to": "وحدة التوزيع - ماريشال كانديدو روندون/PR"، "من": "وحدة العلاج - كوريتيبا/PR"، "موقع": "وحدة المعالجة - CURITIBA/PR"،originalTitle": "يتم نقل الكائن - برجاء الانتظار"، "تفاصيل": "الكائن قيد النقل - برجاء الانتظار"},
                {"date": "03-06-2024 12:25:05"، "to": "وحدة العلاج - CASCAVEL/PR"، "من": "وحدة العلاج - SOROCABA/SP"، "الموقع": "العلاج" الوحدة - SOROCABA/SP"، "originalTitle": "كائن قيد النقل - برجاء الانتظار"، "تفاصيل": "كائن قيد النقل - من فضلك انتظر"}
            ]
        }
    ]
}

أنواع الخدمات

نقطة النهاية: /correios/services/
الطريقة: احصل على

تجعيد الشعر:

curl --location '{{base_url}}/correios/services' 
--header 'Access-token: SEU_ACCESS_TOKEN'

إجابة:

 { "الحالة": "النجاح"، "النتيجة": {"PAC": "04510"، "SEDEX": "04014"، "SEDEX 12": "04782"، "SEDEX 10": "04790"، "SEDEX" اليوم": "04804"
  }
}

احسب الشحن

نقطة النهاية: /correios/calculate/
الطريقة: احصل على

بالنسبة لنوع الأمر، اتبع التعريفات أدناه:

صندوق/عبوة (1)؛
الأسطوانة/المنشور (2)؛
مظروف (3)؛

ملاحظات هامة:

إذا كان مغلفًا، أدخل 0 في ذلك الوقت؛
إذا كان مظروفًا، فلا يجوز أن يتجاوز الوزن 1 كجم؛
إذا كانت لفة/منشور، أبلغ عن قطر العبوة؛
إذا كان Roll/Prisma، أدخل 0 في الارتفاع والعرض؛
إذا كان الصندوق/العبوة، أدخل 0 في القطر؛
بالنسبة لخدمات "اليد الخاصة" و/أو "إشعار الاستلام"، أدخل "Y" - نعم أو "N" - لا؛
القيمة المعلنة اختيارية، وإذا كنت لا ترغب في الإعلان عنها، أدخل 0؛

تجعيد الشعر:

curl --location '{{base_url}}/correios/calculate' 
--header 'Access-token: SEU_ACCESS_TOKEN' 
--header 'Content-Type: application/json' 
--data '{
	"servico": "04510",
	"origem": "85930-000",
	"destinatario": "85960-000",
	"tipo": 1,
	"comprimento": 20,
	"altura": 20,
	"largura": 20,
	"diametro": 0,
	"peso": 0.500,
	"maoPropria": "s",
	"valorDeclarado": 150,
	"avisoRecebimento": "s"
}'

جسم:

 { "الخدمة": "04510"، "المصدر": "12460-000"، "المستلم": "37530-000"، "النوع": 1، "الطول": 20، "الارتفاع": 20، "العرض" : 20، "القطر": 0، "الوزن": 0.500، "handOwn": "s"، "القيمة المعلنة": 150، "إشعار الاستلام": "s"}

إجابة:

 ^ 29.40"، "ValorMaoPropria": "7.50"، "ValorAvisoRecebimento": "6.35"، "ValorValorDeclarado": "2.58"، "التسليم المحلي": "Y"، "SaturdayDelivery": "N"، "obsFim": []، "خطأ": "0"، "MsgError": []
    }
  }
}

الحصول على الاختصار عن طريق ID

نقطة النهاية: /correios/flag/
الطريقة: احصل على

تجعيد الشعر:

curl --location --request GET '{{base_url}}/correios/flag' 
--header 'Access-token: SEU_ACCESS_TOKEN' 
--header 'Content-Type: application/json' 
--data '{
    "Id": "AR"
}'

جسم:

 {"المعرف": "AR"}

إجابة:

 {"النجاح": صحيح،"النتيجة": {"المعرف": "AR"، "الاسم": "إقرار الاستلام"}
}

قائمة بجميع المختصرات

نقطة النهاية: /correios/flags/
الطريقة: احصل على

تجعيد الشعر:

curl --location '{{base_url}}/correios/flags' 
--header 'Access-token: SEU_ACCESS_TOKEN'

إجابة:

 {"success": true،"result": {"AL": {"name": "READING AGENTS"}،AR": {"name": "إقرار الاستلام"}،AS": {" name ": "أمر PAC - العمل الاجتماعي"}،"BE": {"name": "التحويلات الاقتصادية بدون الهواء الرقمي"}،"BF": {"name": "شحن سريع بدون هواء رقمي"}
    }
}