第三方openapi服务接入统一

1、第OpenAPI网络技术,）()面向Open API服务接第OpenAPI网络技术,）()面向Open API服务接12013-06-12013-06-123背适用对象说RestfulOpen API对外接口规基础规请求数据包格接口输入参123背适用对象说RestfulOpen API对外接口规基础规请求数据包格接口输入参HTTP方响应数据包格输出格返回字错误码定系统级错误业务级错误权限控制策频度控制策资控制策高级Open API接口规File-TransferAPI接口规BQLAPI接口规4第Restful Open API接入规基础接入规请求验请求数据包格接口 输入参系统级输入参业务级输入

2、参HTTP方响应数据包格错误码定权限控制策频度控制策控制策5附Open 内网签名算相关规范文档发布站审核意67设计评审意1背2适用对象说RestfulOpenAPIRestful OpenAPIAPI团队提供的各语言版本的1背2适用对象说RestfulOpenAPIRestful OpenAPIAPI团队提供的各语言版本的SDKOpenAPI注：OpenAPIRestful Open API3RestfulOpenAPI外接口规RestfulOpenAPI2.0OpenAPI3.1基础规RestfulOpenAPIURLHTTP3.1.1 请求数据包格 RestfulOpen APIURLOp

3、enAPI。RestfulOpen APIOpen3.1.1 请求数据包格 RestfulOpen APIURLOpenAPI。RestfulOpen APIOpenAPIhttphttps。OpenAPIOpen API类型的依据typeOpenAPIOpen API错误!无效 OpenAPIURL对于非1.0版本的API接口必须以“v” + 数字这种命名方式来命名，如v2建议实在无法做到向下兼容时才能通过在接口 URL 中增加第，resource中的每一个目录名只能包含小写字母、数字、下划线这个集合中的字符持 URL 路径的美观性。例如，user/getInfo 就是一个不好名，用 use

4、r/info 或resource中的每一个目录名只能包含小写字母、数字、下划线这个集合中的字符持 URL 路径的美观性。例如，user/getInfo 就是一个不好名，用 user/info 或revokequery_string由系统级输入参 数和具体 Open API 的业务级 输入参数 组成， 以议HTTPGET，query_stringQUERY输入参每个 UTF-8OpenAPIurlencode系统级输入参6-系统级输入参OpenAPIHTTPOpenAPI6-2系统级输入参6-系统级输入参OpenAPIHTTPOpenAPI6-2级保留参参数参数参数类是否必描否令牌，第 任何需要

5、 才能 的 RestfulAPI 时都必须提供该参数以便 验证其是否是一个合法的第 。对 于 用 户 类 API Authorization Code、Implicit Grant、Resource Owner Password Credentials 、 BDUSS Credentials4 种 流程中的一种所获取到ac s token。对于应用 类 API，其值必须是通过 C nt Credentialsac s token。否API端对所有来源IP一视同方应用的服务端IP更高的频度控制阀值。否通过JS调用Open API时一般需要通过指定callback参数来要求Field 否uname

6、,sex,age，字段名支持 字段以及user字段中的sex属性参数为空或业务级输入参OpenAPI参数命名规表格 6-3级参数的禁用参数名列业务级输入参OpenAPI参数命名规表格 6-3级参数的禁用参数名列6-4业务级输入名约参数参数类描参数所属类v层转给APIv参数类型规6-输入参数类型定参数取值规出于方便、10true参数类型规6-输入参数类型定参数取值规出于方便、10true原则 类型名描字符串，例如以半角逗号隔开的字符串列表，例如数字串，例如以半角逗号隔开的数字串列表，例如以半角逗号隔开的浮点数字串列表，例如true以半角逗号隔开标准时间格式：yyyy-MM-ddHH:mm:ss，

7、例如：2010-11-11以半角逗号隔开的时间串列表，例如：2010-11-11 11:11:11,2010-12-Open APIField 以半角逗号隔开的属性列表，例如uiduiduiduidspage_nopage_size用于支持分页的 API，表示每页返回多少条数据，默认值根据具体API定，建议各个产品线有一个path/home/work/filepath/home/work/file对于开发者来说，在能够实现同样功能的情况下，接口越少越简单 HTTPRestfulOpenAPIGET3.1.2 响应数据包格输出格APIOpenAPIJSONJSONPJSON输出格OpenAPIc

8、allbackcallbackresponseheaderhttp coderesponseheaderContent-TypeOpenAPIresponseresponsebodyJSONJSONP输出格OpenAPIresponseresponsebodyJSONJSONP输出格OpenAPIcallbackcallbackresponseheaderhttp coderesponseheaderContent-TypeOpenAPIresponseresponsebodyJSONPHTTP/1.1200Cache-Control: no-storePragma: no-异常响应输出格re

9、quest_id，error_code,error_msg3response异常响应输出格request_id，error_code,error_msg3responseheaderCache-Controlno-storePragmastokenJSONHTTP/1.1200Cache-Control: no-storePragma: no-stokeninvalidornolongerHTTP/1.1200Cache-Control: no-storePragma: no-stokenJSONP注意：request_id，error_code，error_msg 参数只能在异stokenJ

10、SONP注意：request_id，error_code，error_msg 参数只能在异常响应的输出中出现，正常响应出绝对不能出现这两个参数，通过error_code为0error_msg为s 来表示正常响应是符合规范的返回字junior_schoolHTTP/1.1200Cache-Control: no-storePragma: no-stokeninvalidornolonger返回字段命名规字段，建议6-6返回字名约返回字段类型规须返回字段命名规字段，建议6-6返回字名约返回字段类型规须6-7字段基本数据类型类型名描字符串，例如元素类型为有符号整型的数组，例如元素类型为无符号整型的数

11、组，例如字段字段类描JSON返回字段取值规出于方便应用原则 的 JSON 数组来表示，而不是以半角逗号隔开的字符串来表示，注意这点刚好与输入参数取值规范的相应原则相反JSON返回字段取值规出于方便应用原则 的 JSON 数组来表示，而不是以半角逗号隔开的字符串来表示，注意这点刚好与输入参数取值规范的相应原则相反段的值为 list:robin928,fengwuying ， 则应该遵循本原则将其简化为原则 5段的值为robin928,30，则建议将其字段值改为unamerobin928,sex男,age30，uname、sex、age3元素类型为有符号长整型的数组，例如无符号长整型，例如元素类型

12、为无符号长整型的数组，例如：浮点数据，例如元素类型为浮点数据的数组，例如：12.5, 布尔类型，true元素类型为布尔类型的数组，例如：true，false,标准时间格式：yyyy-MM-ddHH:mm:ss，例如：2010-11-11 二进制数据流，用于返回数据文件内容，数原则 63.1.3 错误码定OpenAPI系统级错误OpenAPI，API6-9级错误码定错误错误信描01Unknown2Servicetemporarily3Unsupported原则 63.1.3 错误码定OpenAPI系统级错误OpenAPI，API6-9级错误码定错误错误信描01Unknown2Servicetem

13、porarily3UnsupportedopenOpenapi4Notodothis限执行当前操5UnauthorizedntIPopenapiIPInvalidInvalidAPIApi keykeyIncorrectUnsupportedsignature参数签名算法未所支Invalids token invalid or no 无效的s stokenstokenkeykeyInvalidbegin_batch already called, 业务级错误3.1.4 权限控制策由层3.1.5 频度控制策由层3.1.6资控制策由层业务级错误3.1.4 权限控制策由层3.1.5 频度控制策由层3

14、.1.6资控制策由层3.1.7 资费控制策由层3.2API口规APIRestfulOpenAPI层File-TransferAPIBQLAPI3.2.1File-Transfer API接口规makesuretocallend_batchcalledbeforeEachbatchAPIcannotn2020Thismethodisnotallowedin编码3.2.2BQLAPI口规4第RestfulOpenAPI入规4.1 基础接入规编码3.2.2BQLAPI口规4第RestfulOpenAPI入规4.1 基础接入规RestfulOpenAPI4.1.1 请求验需要验证请求是来。目前有两种方

15、式验请求是来的如果第的是 https 的， 则转发请求给第的时候会加上bd_op_secret，上；的http服务密钥作为签名密钥，。第API4.1.2 请求数据包格 Open的http服务密钥作为签名密钥，。第API4.1.2 请求数据包格 OpenAPIAPIURL的API服务器端APIpath_prefixAPIOpenAPIURLAPIOpenAPIURLoperationAPI一部分是系统级输入参数， 这部分参数是由当前 Open API 的对外 URL 接口中的query_string另一部分是业务级输入参数， 这部分参数与当前 Open API 的对外 URL 接口中的输入参系统

16、级输OpenAPIURLoperationAPI一部分是系统级输入参数， 这部分参数是由当前 Open API 的对外 URL 接口中的query_string另一部分是业务级输入参数， 这部分参数与当前 Open API 的对外 URL 接口中的输入参系统级输入参系统级输入参数是Open API业务级输入参参数参数类是否必描是调用当前api接口的应用的应用是否当前 api 接口所属的第是https时有效否针对除了自身之外的所有转发参数的参数签名是http时有效RestfulOpenAPIHTTP方GETT4.1.3 响应数据包格第APIJSONRestful Open APIRestfulO

17、penAPIHTTP方GETT4.1.3 响应数据包格第APIJSONRestful Open API在一段时间内都保持不变，则第API 服务端在返回结果给层时，必须通过Cache-ControlOpenAPIJSONP4.1.4 错误码定RestfulOpenAPI4.1.5 权限控制策的层参数即可4.1.6 频度控制策的层参数即可4.1.7资控制策的层Cache-Control: max-4.1.8 资费控制策的层处理，服务只需要5附5.1Open内网Open 4.1.8 资费控制策的层处理，服务只需要5附5.1Open内网Open BVSIP/BDUSSsTokenBVSIP5.2签名算bd_op_sign如k1=v1、k2=v2将格式化好的参数键值对以字典序升序方式排列后，拼接在一起，如functiongenerate_sig($para