API接口TOKEN設計
首先需要知道API是什么？
API（Application Programming Interface）即應用程序接口。你可以認為 API 是一個軟件組件或是一個 Web 服務與外界進行的交互的接口。而我們在這里要談論的，是作為一家公司如何跟外界進行交互。從另一個角度來說，API 是一套協議，規定了我們與外界的溝通方式：如何發送請求和接收響應。
API的特點：
1、因為是非開放性的，所以所有的接口都是封閉的，只對公司內部的產品有效；
2、因為是非開放性的，所以OAuth那套協議是行不通的，因為沒有中間用戶的授權過程；
3、接口分為需要用戶登錄才能訪問的和不需要用戶登錄就可訪問的；
針對以上特點，移動端與服務端的通信就需要兩種不同的TOKEN，一種針對接口的api_token,一種針對用戶的user_token;
一.api_token
它的職責是保持接口訪問的隱蔽性和有效性，保證接口只有可信任的來源才可以訪問，參考思路如下：
按服務器端和客戶端都擁有的共同屬性生成一個隨機串，客戶端生成這個串，服務器也按同樣算法生成一個串，用來校驗客戶端的串。
現在的接口基本是mvc模式，URL基本是restful風格，URL大體格式如下：
http://www.api.com/模塊名/控制器名/方法名?參數名1=參數值1&參數名2=參數值2
接口token生成規則參考如下：
$api_token = md5 ('模塊名' + '控制器名' + '方法名' + '2018-1-18' + '加密密鑰') = 789fed3842aabd834e9a5dd7735532de2
1.'2018-1-18' 為當天時間
2.'加密密鑰'為私有的加密密鑰，手機端需要在服務端注冊一個“接口使用者”賬號后，系統會分配一個賬號及密碼，數據表設計參考如下：
字段名及字段類型
| 1 2 3 |
client_id varchar(20) 客戶端ID
client_secret varchar(20) 客戶端(加密)密鑰 |
參考代碼：
<?php
//獲取GET參數值
$module = $_GET['module'];
$controller = $_GET['controller']
$action = $_GET['action'];
$client_id = $_GET['client_id'];
$api_token = $_GET[''api_token];
//根據客戶端傳過來的client_id，查詢數據庫，獲取對應的client_secret
$client_secret = getClientSecret($client_id);
//服務端重新生成一個api_token
$api_token_server = md5($module . $controller . $action . date('Y-m-d', time()) . $client_secret);
//客戶端傳過來的api_token與服務端生成的api_token進行校對，如果不相等，則表示驗證失敗
if ($api_token != $api_token_server) {
exit('access deny'); //拒絕訪問
}
//驗證通過，返回數據給客戶端
?>
二.user_token
它的職責是保護用戶的用戶名及密碼多次提交，以防密碼泄露。
如果接口需要用戶登錄，其訪問流程如下：
1、用戶提交“用戶名”和“密碼”，實現登錄（條件允許，這一步最好走https）；
2、登錄成功后，服務端返回一個user_token，生成規則參考如下：
user_token = md5('用戶的uid' + 'Unix時間戳') = etye0fgkgk4ca2ttdsl0ae9a5dd77471fgf
服務端用數據表維護user_token的狀態，表設計如下：
字段名及字段類型如下：
| 1 2 3 4 5 |
user_id int(11) 用戶ID
user_token varchar(36) 用戶token
expire_time int 過期時間（Unix時間戳） |
服務端生成user_token后，返回給客戶端（自己存儲），客戶端每次接口請求時，如果接口需要用戶登錄才能訪問，則需要把 user_id與user_token傳回給服務端，服務端接受到這2個參數后，需要做以下幾步：
1、檢測user_token的有效性；
2、刪除過期的user_token表記錄；
3、根據user_id，user_token 獲取表記錄，如果表記錄不存在，直接返回錯誤，如果記錄存在，則進行下一步；
4、更新user_token 的過期時間（延期，保證其有效期內連續操作不掉線）；
5、返回接口數據；
擴充：生成token算法參考：
背景
很多時候我們需要用 token 來作為一些標識, 比如: 一個用戶登錄后的認證標識.
實現方式
md5 的方式:
| 1 2 3 4 |
$v = 1; // 自己定義的 需要hash 的value 值 $key = mt_rand(); // 這里用 隨機串作為key $hash = md5($key . $v . mt_rand() . time()); echo $hash; |
執行結果: b63426a38f86b726ce0d327d48e47376 看着不是很舒服, 作為強迫症的我 是受不了的.
md5 + base64 的方式
| 1 2 3 4 5 |
$v = 1; $key = mt_rand(); $hash = md5($key . $v . mt_rand() . time()); $token = base64_encode($hash); echo $token; |
執行結果: MWQyMjE2NmI3NDA1MmRjZTQwOTQzZDZjMWU1OTE5OGU= 看着稍微舒服些了, 但是還不夠好, 反觀微信的 openid , 一般是不會有后面的 = 號的
優化
| 1 2 3 4 5 |
$v = 1; $key = mt_rand(); $hash = md5($key . $v . mt_rand() . time()); $token = str_replace('=', '', base64_encode($hash)); echo $token; |
執行結果: Yzg4MWU0OTQ0MTRiZTI0YWYwMDJjOTYyODBkNjFmMTM 這下沒有 = 號了, 舒服了些, 但是又太長了, 微信的 openid 可沒這么長
換種 hash 試試
sha1 + base64 的方式
| 1 2 3 4 5 |
$v = 1; $key = mt_rand(); $hash = hash_hmac("sha1", $v . mt_rand() . time(), $key, true); $token = str_replace('=', '', base64_encode($hash)); echo $token; |
執行結果: 7pn0pWzO+/TOoISNtDaewa4CyuXw 是短些了, 可是里面有 +/ 號, 很多情況下用 get 傳遞時會被 urlcode, urlcode 過后就這樣了 7pn0pWzO%2b%2fTOoISNtDaewa4CyuXw, 這顯然不是我們想要的
繼續優化
| 1 2 3 4 5 |
$v = 1; $key = mt_rand(); $hash = hash_hmac("sha1", $v . mt_rand() . time(), $key, true); $token = str_replace('=', '', strtr(base64_encode($hash), '+/', '-_')); echo $token; |
執行結果: JM9AkY7SAIROrJ7fhjIU2ApbMsI 這下不會 urlcode了, 看着也舒服些了, 我目前是這樣用的...