Correios API พร้อม PHP v2.0

ความต้องการ

ผู้แต่ง
PHP >= 8.2

แพ็คเกจ

luannsr12/sdkcorreios

API นี้ครอบคลุมบริการต่อไปนี้:

บริการที่นำเสนอโดยที่ทำการไปรษณีย์
การคำนวณค่าจัดส่งสินค้า
ติดตามคำสั่งซื้อ
ส่งกลับความหมายของตัวย่อที่มีอยู่ในโค้ดติดตาม

วิธีการใช้งาน API

ด้านล่างนี้เป็นคำแนะนำในการใช้งาน:

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

หลังจากดาวน์โหลดและติดตั้ง ให้แก้ไขไฟล์ "config.php" และเพิ่มโทเค็นการเข้าถึงของแอปพลิเคชันของคุณ โทเค็นการเข้าถึงนี้ต้องส่งผ่านส่วนหัวของคำขอ API

ปลายทางทั้งหมด

ติดตามคำสั่งซื้อ

จุดสิ้นสุด: /correios/tracking/
วิธีการ: โพสต์

หยิก:

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"}

การตอบสนอง:

 {"ความสำเร็จ": จริง,"ผลลัพธ์": [
        {"รหัส": "QQ588651634BR", "สถานะ": "การเคลื่อนไหว", "service_provider": "api.melhorrastreio.com.br", "ข้อมูล": [
                {"date": "03-09-2024 07:27:10","to": "Distribution Unit - MARECHAL CANDIDO RonDON/PR","from": "Treatment Unit - CURITIBA/PR","location ": "หน่วยประมวลผล - CURITIBA/PR", "OriginalTitle": "วัตถุกำลังถ่ายโอน - โปรดรอสักครู่", "รายละเอียด": "วัตถุ กำลังโอน - โปรดรอสักครู่"},
                {"date": "03-06-2024 12:25:05","to": "หน่วยบำบัด - CASCAVEL/PR","จาก": "หน่วยบำบัด - SOROCABA/SP","สถานที่": "การบำบัด หน่วย - SOROCABA/SP","OriginalTitle": "วัตถุกำลังโอน - โปรดรอสักครู่", "รายละเอียด": "วัตถุกำลังโอน - กรุณา รอ"}
            -
        -
    -
-

ประเภทของการบริการ

จุดสิ้นสุด: /correios/services/
วิธีการ: GET

หยิก:

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/
วิธีการ: GET

สำหรับประเภทคำสั่งซื้อ ให้ปฏิบัติตามคำจำกัดความด้านล่าง:

กล่อง/บรรจุภัณฑ์ (1);
ลูกกลิ้ง/ปริซึม (2);
ซองจดหมาย (3);

หมายเหตุสำคัญ:

หากเป็น Envelope ให้ใส่ 0 ในขณะนั้น
หากเป็นซองจดหมาย น้ำหนักต้องไม่เกิน 1 กก.
หากเป็นม้วน/ปริซึม ให้แจ้งเส้นผ่านศูนย์กลางของบรรจุภัณฑ์
หากเป็นม้วน/ปริซึม ให้ป้อนความสูงและความกว้างเป็น 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/
วิธีการ: GET

หยิก:

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

ร่างกาย:

 {"รหัส": "AR"}

การตอบสนอง:

 {"success": true,"result": {"Id": "AR","Name": "รับทราบการรับ"}
-

แสดงรายการคำย่อทั้งหมด

จุดสิ้นสุด: /correios/flags/
วิธีการ: GET

หยิก:

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

การตอบสนอง:

 {"success": true,"result": {"AL": {"name": "READING AGENTS"},"AR": {"name": "รับทราบการรับ"},"AS": {" name ": "PAC ORDER – การดำเนินการทางสังคม"},"BE": {"name": "การโอนเงินทางเศรษฐกิจโดยไม่มี DIGITAL AIR"},"BF": {"name": "จัดส่งด่วนโดยไม่ต้องใช้ DIGITAL AIR"}
    -
-