全部产品
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件

API相关约定

更新时间:2017-06-28 18:03:02

本章将介绍HTTP请求结构和数据格式,以及如何构造HTTP请求和解析HTTP请求的返回结果。最后介绍Open Ad请求返回的错误状态码。Java语言的开发者可使用官方的JavaSDK。如果需要使用Java以外的语言访问Open Ad,可以根据本章内容使用HTTP消息与Open Ad进行交互,也可以自行编写SDK,可参考API开发实例

HTTP请求

Open Ad接收应用程序的HTTP请求,执行相应的逻辑并以HTTP消息返回处理后的结果数据。

HTTP请求支持GET和POST两种方式,具体的接口访问支持类型参见具体的接口说明。参数传递既支持GET的URL传递也支持通过JSON协议格式进行组织。下面分别介绍HTTP请求header和body 以及响应的具体格式。

访问Open Ad的URL由以下方式构成:

  1. http://域名/operation

Operation是Open Ad操作名称,可以在后续API Reference对应章节查看所有的Open Ad操作名,大小写敏感。

签名API说明

Open Ad规定HTTP 请求的Header 必须包含以下信息:

Host

请求链接host值

Date

请求日期

Accept

请求类型,例如(application/json)

Version

版本号

Sign

数字签名,通过私钥、host、date、accept、version生成。

请求的签名。签名计算方式如下:

  1. signString = host + "\n" + accept + "\n" + date + "\n" + version + "\n" + dspId;
  2. PKCS8EncodedKeySpec pkcs8KeySpec = new PKCS8EncodedKeySpec(privateKey);
  3. KeyFactory keyFactory = KeyFactory.getInstance(KEY\_ALGORITHM);
  4. PrivateKey privateK = keyFactory.generatePrivate(pkcs8KeySpec);
  5. Signature signature = Signature.getInstance(SIGNATURE\_ALGORITHM);
  6. signature.initSign(privateK);
  7. signature.update(signString);
  8. return Base64Utils.encode(signature.sign());

ORG-DSPID

广告公司ID(必填)

ORG-ADID

广告主ID(广告公司后台API:选填,广告主后台API:必填)

HTTP 响应

Open Ad规定HTTP响应的内容是Open Ad定义的JSON消息序列化之后的字符串。每一个Open Ad请求消息对应一个Open Ad响应消息,应用程序将响应内容反序列化之后,读取Open Ad操作的结果。

本文导读目录