跳到主要内容

OpenAPI

BDP的开放API，包含数据接入和权限管理两部分，使用上各有不同，有独立的返回码。

使用入门​

  1. API地址：不同功能API使用不同的请求地址，使用时注意使用对应的接口；
  2. 数据接入：https://open.bdp.cn/api/
  3. 权限管理：https://open.bdp.cn/api/v2/
  4. 访问权限：OpenAPI目前对所有企业版用户开放， 使用BDP企业版用户名与密码申请访问Token后，即可进行OpenAPI使用；
  5. 用户凭证：BDP使用Token作为账户的唯一凭证，Token目前不会过期，需要妥善保存；
  6. 账户安全：您的Token及BDP账户的用户名和密码会通过Https加密传输；
  7. 数据格式：OpenAPI数据传输均使用JSON格式，具体内容参见各接口；
  8. 接口限制：参见数据接入和权限管理；

接口规范​

OpenAPI是遵循RESTful＋JSON风格的API，使用https协议。

  1. 请求方式：POST，所有接口均推荐使用POST方式提交；

  2. 请求url：API地址＋接口地址；接口地址命名是由接口类型与接口名组成，如下URL代表"数据源创建"的请求URL；

https://open.bdp.cn/api/ds/create
  1. 请求数据:

所有参数必须按url编码；参数及数据须符合JSON格式，推荐通过POST提交；

  • 请求参数：
"access_token": "YOUR_TOKEN"
  • 请求数据：
{
  "data1": [
    "ID1",
    "ID2"
  ],
  "data2": "YOUR_DATA2", //其他参数
  "data3": "YOUR_DATA3", //其他参数
}
  1. 返回信息：接口返回均有如下三部分，根据不同接口有不同返回结果；
{
  "status": 0, //状态码
  "errstr": "", //错误描述
  "result": "" //返回数据
}

数据类型​

BDP中数据支持三种数据类型，上传其他数据类型将会报错：

  • number：整数支持Int类型，超出范围可以上传，但在BDP无法正常展示；小数无限制；
  • string：文本字符串；
  • date：日期数据，格式需为%Y-%m-%d %H:%M:%S，如2015-01-01 00:00:00；不规范的格式会造成计算结果不准确；