Skip to content

Latest commit

 

History

History
244 lines (177 loc) · 11.5 KB

README.md

File metadata and controls

244 lines (177 loc) · 11.5 KB
Raw

English Version

COP on Gitee

0x01 COP

Coscoshipping lines Open-api Platform：目前处于试运行！！！试运行期间提供免费的数据服务。

中远海运集运的Open API主要基于集装箱运输业务，向供应链上下游、前后端延伸，一方面服务于传统运输客户，为行业客户定制信息解决方案，深化和客户的信息合作，增强服务黏性；另一方面通过建立丰富完善的全方位供应链和电子商务API体系，乃至允许第三方（独立开发者、行业解决方案供应商、客户）基于我司的API体系进行定制开发，推动物流信息平台的生态建设。

COP客户应用

为保证用户数据的安全与隐私，COP的客户应用("Application"或称"Consumer")需要经过一定业务申请和审核流程，取得授权后才能接入至COP平台。每个application将被分配一组apiKey和secretKey作为application的识别凭证，开发者务必妥善保存apiKey和secretKey，生产正式环境中的apiKey和secretKey将作为COP客户应用的唯一凭证。

0x02 对外开放的API服务体系

根据对外API需求和模式的不同，其总体技术亦有所区别。对外API模式分为两类：

基于HTTP(S)协议

服务于同步调用和异步调用； 标准/定制同步API

标准异步API

基于MQ协议

服务于异步调用，仅适用于深度定制的应用场景，对于MQ的安全管理、端到端的MQ协议网络等存在要求； 定制异步API

0x03 运行环境说明

调用环境类别 服务地址(HTTPS)
生产正式环境 https://api.lines.coscoshipping.com/service
验证测试环境 https://api-pp.lines.coscoshipping.com/service 
注:后续所有API清单中的URL均是指相对于**服务地址**的路径。

生产正式环境

中远海运集运COP生产正式环境是指中远海运集运COP平台提供给真实的客户、合作方和独立软件开发商的正式生产运行的环境。其中的数据均为真实数据，生产正式环境的apiKey和secretKey是客户应用的唯一凭证，需要妥善保管，客户应用对其在COP平台的行为和数据负有法律责任。

测试环境

TBD.

0x04 接入和审核

入驻成为开发者

入驻审核

申请的业务方将根据入驻申请进行评估审核，并在15个工作日内反馈审核意见。

安全凭证发放

入驻审核通过之后，COP门户网站系统将把您的身份凭证ApiKey/SecretKey发放至您的电子邮箱。如出现SecretKey泄露，请务必在第一时间在COP门户网站申请重置。请参考如何申请重置HMAC

其他疑问

如有其他疑问，请访问客户反馈

限制和约束

基于反DOS、性能和API特性综合考虑，所有API的请求体(HTTP Request Body)长度不得超过1MB。

HTTP协议版本限制为 HTTP/1.1 。

0x05 安全体系

关于SSL证书

在使用的过程中，您可能会出现https/ssl证书信任问题。推荐通过浏览器下载服务器端证书文件后，将该证书加载至信任的证书库中。

keytool -import -trustcacerts -alias cop -keystore "%JAVA_HOME%/JRE/LIB/SECURITY/CACERTS" -file ./api.lines.coscoshipping.com.cer -storepass changeit

Hmac Auth认证体系

  • COP平台为每一个Application发布一组Api Key和Secret Key用以识别Application。COP平台将根据申请和业务需求，指派其对API的访问权限。

  • Hmac Auth 体系使用了Api Key、Secret Key，摘要等技术，对于使用者访问的URI地址和请求报文进行服务端验证，安全性较高，性能开销略高。

  • Illegal Request将无法通过Hmac Auth认证体系，COP将返回401或500的HTTP状态码。

通用实现之HTTP头信息说明

HTTP Header 类型 是否必须
X-Coscon-Date String Yes
X-Coscon-Content-Md5 String Yes
X-Coscon-Digest String Yes
X-Coscon-Authorization String Yes
X-Coscon-Hmac String Yes
  • X-Coscon-Date
格式：EEE, dd MMM yyyy HH:mm:ss z
时区：以GMT/UTC 时区的当前时间，可参考如下代码：

        date = DateFormatUtils.format(new Date(), X_DATE_FORMATTER, TimeZone.getTimeZone("GMT"), Locale.US);
精度：和标准时间偏差不能超过2分钟。
例如：Tue, 23 Oct 2018 12:58:39 GMT
  • X-Coscon-Content-Md5
产生一个UUID，其md5摘要的十六进制表示
  • X-Coscon-Digest
如为http method为POST/PUT，则需对Http Body的字节数组进行SHA256摘要，形成摘要数据字节数组，并对该摘要数据字节数组进行Base64编码，前缀为"SHA-256="，例如：
SHA-256=ndf/mH+sjQ0ZeQhOveXOi9hVzQZtGjTphDInXMa8Jkw=
  • X-Coscon-Authorization
hmac username="$YOUR_ApiKey", algorithm="hmac-sha1", headers="X-Coscon-Date X-Coscon-Digest X-Coscon-Content-Md5 request-line",signature="$Signature"
- $YOUR_ApiKey： COP平台颁发的ApiKey
- $Signature: 以COP平台颁发的secretKey对文本"X-Coscon-Date: $X-Coscon-Date\nX-Coscon-Digest: $X-Coscon-Digest\nX-Coscon-Content-Md5: $X-Coscon-Content-Md5\n$requestLine"进行HmacSHA1摘要后并Base64编码；
- - $X-Coscon-Date:同Http Header['X-Coscon-Date']取值
- - $X-Coscon-Digest:同Http Header['X-Coscon-Digest']取值
- - $X-Coscon-Content-Md5:同Http Header['X-Coscon-Content-Md5']取值
- - $requestLine:参https://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html 之#5.1 Request-Line ，其中Request-URI部分参考(see section 3.2.1 - https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.2.1 , abs_path)
        GET /service/info/tracking/6103622780 HTTP/1.1
  • X-Coscon-Hmac
同Http Header['X-Coscon-Content-Md5']取值

Java实现样例1

Hmac安全和摘要处理

  • 初始化并设置ApiKey和SecretKey
    //com.coscon.oaclient.pure.HmacPureExecutor
    hmacPureExecutor = new HmacPureExecutor();
    hmacPureExecutor.setApiKey("YOUR_API_KEY");
    hmacPureExecutor.setSecretKey("YOUR_SECRET_KEY");
  • 根据HTTP(S)处理组件不同，设置HTTP Header信息
    Map<String, String> headers = getHmacPureExecutor().buildHmacHeaders(request.getRequestLine().toString(), httpContent);
    if(headers!=null) {
        for(Entry<String, String> e:headers.entrySet()) {
            request.addHeader(e.getKey(), e.getValue());
        }
    }

Java实现样例2 - HttpClient

HttpClient样例代码

com.coscon.openapi.client.httpclient.CargoTrackingTestcase
  • 初始化并设置ApiKey和SecretKey
    /*com.coscon.openapi.client.httpclient.AbstractOpenapiTestcase#setUp*/
    hmacPureExecutor = new HmacPureExecutor();
    hmacPureExecutor.setApiKey("YOUR_API_KEY");
    hmacPureExecutor.setSecretKey("YOUR_SECRET_KEY");
  • 在HttpClientBuilder中，注册Interceptor用以进行访问安全预处理
    HttpClientBuilder builder = HttpClientBuilder.create();
    builder.addInterceptorLast(new HttpRequestInterceptor() {

        @Override
        public void process(HttpRequest request, HttpContext context) throws HttpException, IOException {
            if(!match(request, hostPatterns)) {
                return;
            }
            byte[] httpContent = new byte[0];
            if (request instanceof HttpEntityEnclosingRequest) {
				HttpEntity entity = ((HttpEntityEnclosingRequest) request).getEntity();
				if(entity != null) {
					httpContent = IOUtils.toByteArray(entity.getContent());
				}
            }
            try {
                Map<String, String> headers = getHmacPureExecutor().buildHmacHeaders(request.getRequestLine().toString(), httpContent);
                if(headers!=null) {
                    for(Entry<String, String> e:headers.entrySet()) {
                        request.addHeader(e.getKey(), e.getValue());
                    }
                }
            } catch (OpenClientSecurityException e) {
                e.printStackTrace();
            }
        }
    });

PHP Sample

PHP SDK reference

0x06 全局代码

详情请点击：全局代码

0x07 API清单

用户类型 模块 服务 文档 流量限制
公共组 公共查询 货物跟踪 说明 doc 账号级别，每天至多1000次，每月至多30000次
      船期查询 说明 doc 账号级别，每天至多1000次，每月至多30000次
    内贸服务  订舱确认书下载 说明 doc 账号级别，每天至多1000次，每月至多30000次
      签收单链接查询 说明 doc 账号级别，每天至多1000次，每月至多30000次
      运单下载 说明 doc 账号级别，每天至多1000次，每月至多30000次
      订单信息查询 说明 doc 账号级别，每天至多1000次，每月至多30000次
      订单信息变更查询 说明 doc 账号级别，每天至多1000次，每月至多30000次
      TRUCK-车队接口标准套件-提箱校验码 说明 doc 账号级别，每天至多1000次，每月至多30000次
      TRUCK-车队接口标准套件-拖车动态接收 说明 doc 账号级别，每天至多1000次，每月至多30000次

0x08 协议和约定

当您提出入驻申请，即认为您已经同意如下协议和约定：

协议和约定
中远海运集运开放平台合作伙伴开发协议.docx
中远海运集运开放平台合作伙伴应用安全规范.docx
中远海运集运开放平台运营规则.docx