文档中心 > 开发文档 > API调用指南

API调用指南

本文主要引导大家通过开放平台官方提供的技术规范，进行一次API的调用，并对调用的逻辑和结果进行一些简单的讲解。

API接口交互流程说明

同步型

  1. 合作伙伴系统发出请求
  2. ShopEx开放平台接到请求数据，对数据进行业务处理，完成后直接返回处理结果给合作伙伴系统

异步型

  1. 1. 合作伙伴系统发出请求
  2. 2. ShopEx开放平台接到请求数据，返回收到标志给合作伙伴系统
  3. 3. ShopEx开放平台进行异步业务处理，完成后ShopEx开放平台发送业务处理结果给合作伙伴系统
  4. 4. 合作伙伴系统接到处理结果，返回收到成功标志给ShopEx开放平台，ShopEx开放平台不再重试；否 则ShopEx开放平台 不断重试，直到过期

API接口说明

调用SOP的API接口时，即是与SOP服务器进行一次数据交互的过程，所有的API都是基于REST基础的接口规范，可兼容多种编程语言，同时大部分API都支持http post方法。

API接口调用

1.功能说明

系统介绍调用环境入口地址，接口的参数、签名算法、注意事项

2.环境入口地址

API正式环境同步地址：http://matrix.ecos.shopex.cn/sync

API正式环境异步地址：http://matrix.ecos.shopex.cn/async

3.签名算法

调用API所需要参数为系统级参数以及应用级参数如下所示：其中签名算法说明以及示例代码详见文档

4.API调用注意事项

  1. 所有的请求和响应数据编码皆为utf-8格式，url里的所有参数值请做urlencode编码。如果请求的Content-Type是application/x-www-form-urlencoded， http body里的所有参数值也做urlencode编码；如果是multipart/form-data格式，每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8

  2. 所有api请求和响应内的日期格式都为yyyy-MM-dd HH:mm:ss，注意小时格式是24小时制，例如：2008-03-12 18:23:43

  3. 所有api请求参数内的format(即返回格式)可选值为json,xml,目前只支持json

  4. 所有支持分页的api,默认page_size为40,默认page_no为1

  5. 签名方式为 ABC(md5(ABC(md5(key + value .... key + value)) + token)),ABC为举例大写函数，其中key,value对是除签名和图片外的所有请求参数按key做的升序排列, value无需编码

  6. 所有api强制使用http post方法