取得 OSS 的上傳憑證
更新時間:2022-09-02 18:08:07
介面 URL
https://api.polyv.net/live/v3/common/image/get-token
介面說明
1、接口用于获取上传OSS的凭证
2、接口支持https
支援格式
JSON
請求方式
GET
請求次數限制
TRUE
請求參數
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | 是 | string | 從 API 設定中取得,在直播系統登記的 appId |
| timestamp | 是 | long | 13 位當前時間戳 |
| sign | 是 | String | 簽名,為 32 位大寫的 MD5 值,產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有 API 都必須透過客戶自己的伺服器中轉呼叫 POLYV 伺服器取得回應資料【詳見簽名產生規則】 |
回應成功 JSON 範例:
{
"code": 200,
"status": "success",
"message": "",
"data": {
"accessid": "LTAIjcVf4Pr7yABI",
"signature": "j8VTDUnrHMIfVgkRiyIUrSrI1hg=",
"expire": "1555923547",
"host": "liveimages.videocc.net",
"dir": "uploadimage/20190422/",
"policy": "eyJleHBpcmF0aW9uIjoiMjAxOS0wNC0yMlQwODo1OTowNy45MThaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMzIyMTIyNTQ3MjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidXBsb2FkaW1hZ2UvMjAxOTA0MjIvIl1dfQ=="
}
}
回應失敗 JSON 範例:
未輸入 appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId 不正確
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
時間戳錯誤
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
簽名錯誤
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
欄位說明
| 參數名 | 說明 |
|---|---|
| code | 回應代碼,成功為 200,失敗為 400,簽名錯誤為 401,異常錯誤 500 |
| status | 成功為 success,失敗為 error |
| message | 錯誤時的錯誤提示訊息 |
| data | 成功回應時的相關憑證資訊 |
PHP 請求範例
<?php
//引用config.php
include '/srv/http/config.php';
$params = array(
'appId' => $appId,
'timestamp' => $timestamp
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "https://api.polyv.net/live/v3/common/image/get-token?".http_build_query($params);
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);
echo $res;
?>
