接口预录文档是对接海关过程中的关键工具,特别是在自动化和标准化数据交换中扮演着至关重要的角色。这份文档详细描述了如何通过POST请求方式与特定的API进行交互,以便于海关系统处理和验证信息。以下是主要内容的详细解读:
1. **请求方法**: 文档明确了使用POST请求作为发送数据的方式,这是HTTP协议中最常用的数据交换方式,尤其适合结构化数据如JSON。
2. **内容类型**: 请求内容需要以JSON格式编写,这是一种轻量级的数据交换格式,易于解析和处理,适用于现代Web服务接口。
3. **请求地址**: 提供了具体的请求URL,即`http://CLPYULU.COM/API/Send`,这是接口调用的基础,开发者需要知道这个地址才能发送数据。
4. **请求参数**:
- **type**: 必填参数,表示请求类型,值固定为2,可能是对特定接口功能的标识。
- **groupId** 和 **groupKey**: 商户号和密钥,用于身份验证,每个商户都有独特的标识和安全密钥。
- **userName**: 用户名称,可能代表操作员或系统的用户名。
- **RTR**: 冷藏温度,仅允许输入数字,可能用于物流跟踪或温度控制要求。
- **shipName_voyNo**: 船名和航次,用于物流信息,需按照指定格式提供。
- **placeDelivery**: 交货地,需要与装箱单上的信息对应。
- **portDischargeCo**: 卸货港口,同样与装箱单上的卸货信息匹配。
- **contNo**: 箱号,货物的唯一标识。
- **sealNo**: 封号,确保货物封装完整性的编号。
- **contSize**: 箱型和箱类,用于货物尺寸分类。
- **contTareWt**: 箱皮重,包含箱子本身的重量。
- **packerName** 和 **packerAddress**: 装箱人的名称和地址,可选填。
- **cntrOptr**: 营运人信息,可能涉及到承运商或货运代理。
- **arrbillNo**: 提单号,货物运输的重要凭证,只允许字母和数字,无空格。
- **arrPackages**: 件数,需要为整数。
- **arrGW**: 毛重,货物的总重量,有精度限制。
- **arrMEAS**: 尺码(体积),同样需要精确到小数点后三位。
- **CLS**: 危险品等级,如果货物涉及危险品,此处需填写相应等级。
这些参数的准确填写至关重要,因为它们包含了海关需要的详细货物信息,用于清关、税收计算和监控物流流程。通过预录接口文档,开发人员可以预先规划请求,确保数据一致性,提高效率,并减少错误的可能性。
接口预录文档在海关对接中起到了桥梁的作用,它规范了数据传递的格式和流程,使得技术团队能够顺利地与海关系统进行数据交换,确保了业务的顺利进行。