接口规范
所有文档

          Cloud DSP

          接口规范

          通用约定

          • 所有编码都采用UTF-8
          • 日期格式采用yyyy-MM-dd方式,如2015-08-10
          • 时间格式采用UTC格式:yyyy-MM-ddTHH:mm:ssZ,如2015-08-20T01:24:32Z
          • Content-type为application/json; charset=UTF-8
          • object类型的key必须使用双引号(")括起来。
          • object类型的key必须使用lowerCamelCase表示。

          公共请求头

          名称 是否必须 描述
          host 必须 包含API的域名,clouddsp.bj.baidubce.com
          authorization 必须 包含Access Key与请求签名
          x-bce-date 可选 日期格式如2015-03-24T13:04:26Z
          content-type 可选 application/json; charset=utf-8
          content-length 可选 内容长度

          公共响应头

          名称 说明
          Content-Type 只支持JSON格式,application/json; charset=utf-8
          x-bce-request-id 该请求的ID,用于定位问题。

          ENDPOINT

          Cloud DSP的SaaS服务目前仅提供了"华北-北京"区域的访问。服务域名支持HTTP和HTTPS两种调用方式。为了提升数据的安全性,建议通过HTTPS调用。

          服务地址如下:

          服务名 服务地址
          adlib https://clouddsp.bj.baidubce.com/adlib
          finance https://clouddsp.bj.baidubce.com/finance
          dashboard https://clouddsp.bj.baidubce.com/dashboard
          console https://clouddsp.bj.baidubce.com/console

          访问控制

          本服务所有的API都进行签名认证,以保障用户的安全。安全认证采用百度智能云统一的Access Key与请求签名机制。

          Access KeyAccess Key IDSecret Access Key组成,均为字符串,由百度智能云官方颁发给用户。其中Access Key ID用于标识用户身份,Secret Access Key 是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。

          对于每个HTTP请求,用户需要使用下文所描述的方式生成一个签名字符串,并将认证字符串放在HTTP请求的Authorization头域里。

          签名字符串格式:

          bce-auth-v{version}/{accessKeyId}/{timestamp}/{expireTime}/{signedHeaders}/{signature}

          其中:

          • version是正整数,目前取值为1。
          • timestamp是生成签名时的时间,时间格式符合通用约定。
          • expireTime表示签名有效期限,单位为秒,从timestamp所指定的时间开始计算。
          • signedHeaders是签名算法中涉及到的头域列表。头域名字之间用分号(;)分隔,如host;x-bce-date;列表按照字典序排列;当signedHeaders为空时表示取默认值。
          • signature是256位签名的十六进制表示,由64个小写字母组成,生成方式由如下签名生成算法给出。
          • 签名生成算法:

            有关签名生成算法的具体介绍,请参看百度智能云鉴权认证机制

          请求响应格式标准

          • 请求

          作为示例,以下是一个标准的查询特定DSP集群的User请求内容:

          GET /adlib/v1/cluster/0/user/1 HTTP/1.1
          x-bce-date: 2015-03-24T13:04:26Z
          host: clouddsp.bj.baidubce.com
          accept: */*
          content-type: application/json
          authorization: bce-auth-v1/48bd9a68a6197b4bbdf0341f228b4cce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075bs7x16b846a356d1db86e73abba1aed51b4d7b0a95321f69f17250b1

          如果是POST请求,则需要使用JSON格式的结构体来作为Body。

          错误响应

          当调用接口出错时,将返回通用的错误格式。Http的返回状态码为4xx或5xx,返回的消息体将包括全局唯一的请求ID、错误代码以及错误信息。

          调用方可根据错误码以及错误信息定位问题,当无法定位到错误原因时,可以发工单联系百度技术人员,并提供requestId以便于快速地帮助您解决问题。

          消息体示例:

          {
           "requestId":"ae7f8671-9d73-4041-ae00-b168de1e8e62",
           "code": "InvalidHTTPAuthHeader",
           "message": "The HTTP authorization header is invalid. Consult the services documentation for details."
          }

          公共错误码

          code message HTTP status code
          InappropriateJSON The JSON you provided was well-formed and valid, but not appropriate for this operation 400
          InvalidHTTPAuthHeader The HTTP authorization header is invalid. Consult the service documentation for details 400
          InvalidHTTPRequest There was an error in the body of your HTTP request. 400
          InvalidURI Could not parse the specified URI. 400
          MalformedJSON The JSON you provided was not well-formed. 400
          RequestExpired Request has expired. Timestamp date is xxx 400
          SignatureDoesNotMatch The request signature we calculated does not match the signature you provided. 400
          AccessDenied Access denied. 403
          InvalidAccessKeyId The Access Key ID you provided does not exist in our records. 403
          OptInRequired A subscription for the service is required. 403
          IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. 403
          SignatureValidateError The access key signature validate failed 403
          InvalidVersion The API version specified was invalid. 404
          InvalidURLPath The url path was invalid. 404
          PreconditionFailed The specified If-Match header doesn't match the ETag header 412
          InternalError We encountered an internal error. Please try again. 500
          上一篇
          简介
          下一篇
          Adlib广告库管理相关接口