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": “无需数字航空的快递”}
    }
}