# 接口使用指南

# 请求数据格式

  • 当接口需要POST方式请求,请求数据推荐使用form-data格式,而不是x-www-form-urlencoded。 当接口需要GET方式请求时, 请求数据需要放置在url参数中。

# 数据返回格式

  • 接口返回数据结构和header类型 所有接口返回格式均为json,Content-type:application/json;charset=utf-8

# 公共参数

  • 以下公共参数为所有接口必须携带的参数。

# 使用GET方式请求的接口

Query

参数名称 是否必须 示例 备注
app_key 商户app_key
rand_str 32位随机字符串,不可重复
request_time 当前秒级时间戳,需要与服务器标准时间相差不超过3分钟
sign 验证加密字符串
  • 以上参数均为必填项
  • GET方式请求接口时,以上参数需要生成QueryParam拼接到要请求的url中
  • 参数rand_str应当在每次请求时随机生产32位字符串,不使用重复值
  • 参数request_time应当保证时间戳与服务器标准时间尽量保持小的误差
  • 参数sign生成算法: md5(app_key+md5(app_secret+"dolit-cloud-openapi-v1"+rand_str) + request_time),app_secret是指您的商户秘钥,可登录您的商户后台查看。
  • GET方式调用示例
<?php
$app_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";  //您的商户app_key
$rand_str = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; //生产32位随机字符串
$app_secret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; //您的商户秘钥app_secret
$request_time = time();
$sign = md5($app_key + md5($app_secret+"dolit-cloud-openapi-v1"+$rand_str) + $request_time)));
$params_arr = array(
	"app_key" => $app_key,
	"rand_str" => $rand_str,
	"request_time" => $request_time,
	"sign" => $sign,
);
$params = http_build_query($params_arr);
$base_url = "http://xxx.com/xxx?";
$req_url = $base_url+$params;
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_URL, $req_url);
$res = curl_exec($curl);
curl_close($curl);
echo $res;

# 使用POST方式请求的接口

# 公共Header

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data; boundary={cal when sent} 支持application/x-www-form-urlencoded类型

Body

参数名称 是否必须 示例 备注
app_key 商户app_key
rand_str 32位随机字符串,不可重复
request_time 当前秒级时间戳,需要与服务器标准时间相差不超过3分钟
sign 验证加密字符串
  • 以上参数均为必填项
  • POST方式请求接口时,以上参数需要通过post方式发送到服务端。支持x-www-form-urlencoded或者form-data两种请求方式
  • 参数rand_str应当在每次请求时随机生产32位字符串,不使用重复值
  • 参数request_time应当保证时间戳与服务器标准时间尽量保持小的误差
  • 参数sign生成算法: md5(app_key+md5(app_secret+"dolit-cloud-openapi-v1"+rand_str) + request_time),app_secret是指您的商户秘钥,可登录您的商户后台查看。

# 接口使用场景说明

  • 云流化系统对接第三方系统集成,实现对服务器,内容,流路的管理
  • 按需按场景生成串流访问地址:
 1 动态分配服务资源,实现用时动态启动,闲置时关闭资源。
 2 对于预启动的资源,自动搜索指定资源的空闲流路。