API接口TOKEN設計

首先須要知道API是什麼？

 

API（Application Programming Interface）即應用程序接口。你能夠認爲 API 是一個軟件組件或是一個 Web 服務與外界進行的交互的接口。而咱們在這裏要談論的，是做爲一家公司如何跟外界進行交互。從另外一個角度來講，API 是一套協議，規定了咱們與外界的溝通方式：如何發送請求和接收響應。

 

API的特色：

 

　　一、由於是非開放性的，因此全部的接口都是封閉的，只對公司內部的產品有效；

 

　　二、由於是非開放性的，因此OAuth那套協議是行不通的，由於沒有中間用戶的受權過程；

 

　　三、接口分爲須要用戶登陸才能訪問的和不須要用戶登陸就可訪問的；

 

針對以上特色，移動端與服務端的通訊就須要兩種不一樣的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實現流程以下：

 

<?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

 

　　 它的職責是保護用戶的用戶名及密碼屢次提交，以防密碼泄露。

 

　　若是接口須要用戶登陸，其訪問流程以下：

 

　　　　一、用戶提交「用戶名」和「密碼」，實現登陸（條件容許，這一步最好走https）；

 

　　　　二、登陸成功後，服務端返回一個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個參數後，須要作如下幾步：

 

　　　　   一、檢測user_token的有效性；

 

　　　　二、刪除過時的user_token表記錄；

 

　　　　三、根據user_id，user_token 獲取表記錄，若是表記錄不存在，直接返回錯誤，若是記錄存在，則進行下一步；

 

　　　　四、更新user_token 的過時時間（延期，保證其有效期內連續操做不掉線）；

 

　　　　五、返回接口數據；

 

接口用例以下：添加測試接口

 

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

URL： http: //www.api.com/demo/index/add-demo?client_id=wt373uesksklwkskx36sr5858t6&api_token=880fed4ca2aabd20ae9eessa74711de2&user_token=etye0fgkgk4ca2asehxlejeje5dd77471fgf&user_id=12    請求方式： POST    POST參數：title=哈嘍&content=個人世界    返回數據：    {         'code' => 1, // 1:成功 0:失敗         'msg' => '成功/失敗，無權訪問'         'data' => []    }