登入介面
更新時間:2022-09-02 18:08:07
介面URL
http://{自定义的后台域名}/login-check
介面說明
1、接口用于登录
2、接口支持https
支援格式
JSON
請求方式
POST
請求數限制
TRUE
請求參數
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | 是 | string | 呼叫介面所需的APPID |
| timestamp | 是 | long | 13位當前時間戳 |
| sign | 是 | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| 是 | string | 電子郵件地址 | |
| passwd | 是 | string | 登入密碼 |
回應成功JSON範例:
{
"code": 200,
"status": "success",
"message": "",
"data": "http://xxxxxxx.xxxxx.com/#/channel"
}
回應欄位說明
| 參數名 | 說明 |
|---|---|
| code | 狀態碼,成功為200,簽名失敗為403,參數錯誤為400,伺服器端錯誤為500 |
| status | 成功為success,錯誤時為error |
| message | 成功為"",錯誤時為錯誤描述資訊 |
| data | 登入成功後,需要跳轉的地址 |
回應失敗JSON範例:
參數錯誤
{
"code": 400,
"status": "error",
"message": "param validate error",
"data": 400
}
未輸入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": ""
}
php請求範例
<?php
//引用config.php
include 'config.php';
$email = "xxxxx@xxxx.com";
$passwd = "123456";
$params = array(
'appId' => $appId,
'timestamp' => $timestamp,
'email' => $email,
'passwd' => $passwd,
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "http://{自定义的后台域名}/login-check?".http_build_query($params);
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
$res = curl_exec($curl);
curl_close($curl);
echo $res;
?>
