下行接口：客如云提供给合作方调用的接口。例如：订单创建、取消接口，由合作方主动发起请求。
上行接口：合作方提供给客如云调用的接口。例如：配送下单、订单状态回调，由客如云主动发起请求。推送相关状态消息给开发者，该回调地址在【开发者中心-服务列表-回调地址】配置，建议将其配置成https的地址。 注： 上行接口开发者收到客如云推送的消息后需按照文档中的参数格式给客如云返回信息，否则客如云不会持续给开发者推送消息。
正式环境: https://openapi.keruyun.com
oauth2: https://open.keruyun.com
注意： oauth2只有oauth授权接口才可用到改域名，其它接口统一使用正式环境域名
开放平台接口HTTP请求方式包含两种：HTTP POS、HTTP GET
若为HTTP POS请求时，请求头类型：Content-Type=application/json
开放平台接口参数分为两类： 第一类：请求参数，包含系统参数和业务参数 第二类：响应参数
请求所有接口均需要携带的参数，用于开发者身份认证和数据安全校验。系统参数包括：
| 参数名 | 类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| appKey | string | 是 | 开发者申请服务客如云分配的appKey |
| shopIdenty /brandId | Long | 是 | 客如云门店id （门店维度授权接口传递门店ID）/客如云品牌id（品牌授权的接口传递品牌ID）接口授权方式每个接口中有说明 |
| version | string | 是 | 版本,默认2.0（1.0版本仍可用） |
| timestamp | long | 是 | 时间戳,单位:秒,时间戳校验签名,开放平台校验签名时用此参数和服务器当前时间戳对比不能大于300秒，我方服务器使用阿里云授时中心 |
| sign | string | 是 | 签名，64位长度的字符串，获取规则详见签名规则 |
业务参数是指调用具体某个接口时需要的和业务相关的参数，通常不同的接口有不同的业务参数。业务参数统一使用JSON字符串表示,如业务请求参数中包含brandIdenty、operation、dishTypeIds字段，则传入方式如下：
{
"brandIdenty":32295,
"operation":1,
"dishTypeIds":[261813213542561792,263716834186703872]
}
所有接口响应均为json格式。接口响应有统一的格式：
{
"code": 0,
"message": "成功[OK]",
"result": {
"orderId": "f14cfdb04119451998200d1a83f785da"
}
}
code为 "成功[OK]"表示请求成功，其他情况都为请求失败
{
"code": 2003,
"message": "订单不存在",
"messageUuid": "647341641846146",
"result": {
"orderId": "f14cfdb04119451998200d1a83f785da"
}
}
code定义参见4，错误码定义，message字段为错误描述信息。 messageUuid为本次调用产生的唯一标识id，接口调用异常，可以提供此id号用于问题排查。
不允许对API接口进行压测，一经发现，立即禁用appkey 所有接口请用https访问