天天看點

APP接口設計,驗證

接口特點彙總:

1、因為是非開放性的,是以所有的接口都是封閉的,隻對公司内部的産品有效;

2、因為是非開放性的,是以OAuth那套協定是行不通的,因為沒有中間使用者的授權過程;

3、有的接口需要使用者登入才能通路;

4、有的接口不需要使用者登入就可通路;

針對以上特點,移動端與服務端的通信就需要2把鑰匙,即2個token。

第一個token是針對接口的(api_token);

第二個token是針對使用者的(user_token);      

1、先說第一個token(api_token)

它的職責是保持接口通路的隐蔽性和有效性,保證接口隻能給自家人用,怎麼做到?參考思路如下:

按伺服器端和用戶端都擁有的共同屬性生成一個随機串,用戶端生成這個串,伺服器也按同樣算法生成一個串,用來校驗用戶端的串。

現在的接口基本是mvc模式,URL基本是restful風格,URL大體格式如下:

子產品名/控制器名/方法名?參數名1=參數值1&參數名2=參數值2&參數名3=參數值3

接口token生成規則參考如下:

api_token = md5 ('子產品名' + '控制器名' + '方法名' + '2013-12-18' + '加密密鑰') = 770fed4ca2aabd20ae9a5dd774711de2      

其中的

1、 ‘2013-12-18’ 為當天時間,

2、 ‘加密密鑰’ 為私有的加密密鑰,手機端需要在服務端注冊一個“接口使用者”賬号後,系統會配置設定一個賬号及密碼,資料表設計參考如下:

字段名             字段類型        注釋
client_id       varchar(20)     用戶端ID
client_secret   varchar(20)      

服務端接口校驗,PHP實作流程如下:

<?php
 #1、擷取 GET參數 值
$module = $_GET['mod'];
$controller = $_GET['ctl']
$action = $_GET['act'];
$client_id = $_GET['client_id'];
$api_token = $_GET[''api_token];

 #2、根據用戶端傳過來的 client_id ,查詢資料庫,擷取對應的 client_secret
$client_secret = getClientSecretById($client_id);

 #3、服務端重新生成一份 api_token
$api_token_server = md5($module . $controller . $action .  date('Y-m-d', time()) .  $client_secret);
 #4、用戶端傳過來的 api_token 與服務端生成的 api_token 進行校對,如果不相等,則表示驗證失敗
if ($api_token != $api_token_server) {
    exit('access deny');   #拒絕通路
}
 #5、驗證通過,傳回資料給用戶端      

2、再說第二個token(user_token)

它的職責是保護使用者的使用者名及密碼多次送出,以防密碼洩露。

如果接口需要使用者登入,其通路流程如下:

1、使用者送出“使用者名”和“密碼”,實作登入(條件允許,這一步最好走https);

2、登入成功後,服務端傳回一個 user_token,生成規則參考如下:

user_token = md5(‘使用者的uid’ + ‘Unix時間戳’) = etye0fgkgk4ca2aabd20ae9a5dd77471fgf

服務端用資料表維護user_token的狀态,表設計如下:

字段名 字段類型    注釋
user_id int 使用者ID
user_token  varchar(36) 使用者token
expire_time int      

服務端生成 user_token 後,傳回給用戶端(自己存儲),用戶端每次接口請求時,如果接口需要使用者登入才能通路,則需要把 user_id 與 user_token 傳回給服務端,服務端接受到這2個參數後,需要做以下幾步:

1、檢測 api_token的有效性;
2、删除過期的 user_token 表記錄;
3、根據 user_id,user_token 擷取表記錄,如果表記錄不存在,直接傳回錯誤,如果記錄存在,則進行下一步;
4、更新 user_token 的過期時間(延期,保證其有效期内連續操作不掉線);
5、傳回接口資料;      

接口用例如下:

3、釋出日志

URL:  http://blog.net/zhezhebie/article/details?client_id=wt3734wy636dhd3636sr5858t6&api_token=880fed4ca2aabd20ae9a5dd774711de2&user_token=etye0fgkgk4ca2aabd20ae9a5dd77471fgf&user_id=12      
{
      'code' => 1, // 1:成功 0:失敗
      'msg' => '操作成功' // 登入失敗、無權通路
      'data'      

繼續閱讀