公共头
公共请求头和响应
概述
支持的HTTP方法,如无特殊说明,均为POST;
支持的Content-Type,通常情况下均为application/json ,在有file类型的数据传入时,为mutipart/form-data,请在阅读接口文档时特别关注;
BXEO需要调用方将通用参数置于header中,接口自身的参数置于body中传输。
公共请求头
名称 | 类型 | 说明 | 示例值 |
---|---|---|---|
X_BXEO_APP_ID | string | AK值,BXEO系统为每个应用分配的唯一标识 | lf2a69d4dff7dc9f3a462719da8bb943 |
X_BXEO_NONCE | string | 每次请求的唯一标识,由应用自己生成并传入,BXEO会根据nonce的值阻止重入请求 | a1651028088 |
X_BXEO_SIGN | string | 本次请求的签名,签名算法见下文 | dc43920e163fe8423ee512418a3880aae05bf0d00997a58f185f49f4fe77a13f |
X_BXEO_TIMESTAMP | string | 本次请求时间戳。格式为UNIX时间戳,即:从1970年1月1日(UTC/GMT的午夜)开始所经过的秒数,不考虑闰秒 | 1651028088 |
X_BXEO_CONTENTMD5 | string | 本次请求body中原文的md5,具体算法见下文 | 57e37568a871d537d25cd19a9dc10cb7 |
X_BXEO_SIGNTYPE | string | 固定传入HMAC-SHA256 | HMAC-SHA256 |
content-type | string | application/json | application/json |
公共响应头
名称 | 类型 | 说明 | 示例值 |
---|---|---|---|
content-type | string | application/json | application/json |
Body要求
根据content-type不同,body有两种情况:
1.当content-type为application/json时,BXEO要求body为以bexoContent为KEY的json结构,举例说明:
假如当前接口所需要字段a的值为A,b的值为B,C的值为1,则此次请求的BODY应为如下的json串:{"bxeoContent":{"a":"A","b":"B","c":1}}, 对应的curl请求类型如下:curl -X POST -H "Content-Type:application/json" -d '{"bxeoContent":{"a":"A","b":"B","c":1}}' https://xuper.baidu.com/saas/openapi/econtract/v1/jsondemo
2.当content-type为mutipart/form-data时,POST的请求为param形式,使用key1=value1&key2=value2的形式,和上面相同的例子下对应的curl请求为:
curl -X POST -H "Content-Type:mutipart/form-data" -d 'a=A&b=B&c=1' https://xuper.baidu.com/saas/openapi/econtract/v1/formdatademo
注意,content-type为mutipart/form-data 主要是为了支持file类型的传输,不用语言支持的形式有所不同,请调入方使用对应的方式完成此类请求。