PHP v2.0 的 Correios API

要求

作曲家
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。

 { "objects": ["QQ588651634BR"], "provider": "Muambator"}

回覆:

 {“成功”：true，“結果”：[
        {"code": "QQ588651634BR","status": "MOVMENT","service_provider": "api.melhorrastreio.com.br","data": [
                {"date": "03-09-2024 07:27:10","to": "分配單位 - MARECHAL CANDIDO RONDON/PR","from": "治療單位 - CURITIBA/PR","location ": "處理單元- CURITIBA/PR","originalTitle": "正在傳送物件- 請稍候","details": "對象正在傳輸 - 請稍候"},
                {"date": "03-06-2024 12:25:05","to": "治療裝置 - CASCAVEL/PR","from": "治療裝置 - SOROCABA/SP","location": "治療單位- SOROCABA/SP","originalTitle": "物件正在傳送- 請稍候","details": "物件正在傳送- 請等待等待”}
            ]
        }
    ]
}

服務類型

端點：/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/計算/
方法：獲取

對於訂單類型，請遵循以下定義：

盒/包 (1)；
滾輪/棱鏡 (2)；
信封 (3)；

重要提示：

如果是信封，則當時輸入0；
如果是信封，重量不能超過1kg；
如果是卷狀/棱柱狀，請告知包裝直徑；
如果是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”， 「declaredvalue」：150，「收貨通知」：「s」}

回覆:

 ^ 29.40", "ValorMaoPropria": "7.50", "ValorAvisoRecebimento": "6.35", “ValorValorDeclarado”：“2.58”，“Domiciliar Delivery”：“Y”，“SaturdayDelivery”：“N”，“obsFim”：[]，“Error”：“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"
}'

身體：

 {“ID”：“AR”}

回覆:

 {“成功”：true，“結果”：{“Id”：“AR”，“名稱”：“確認收到”}
}

列出所有縮寫詞

端點：/correios/flags/
方法：獲取

捲髮：

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

回覆:

 {"success": true,"result": {"AL": {"name": "READING AGENTS"},"AR": {"name": "ACKNOWLEDGMENT OF RECEIPT"},"AS": {" name ": "PAC 指令– 社會行動"},"BE": {"name": "無須數位航空的經濟匯款"},"BF": {"name": 「無需數位航空的快遞」}
    }
}