php的api接口
在實際工作中,使用PHP寫api接口是經常做的,PHP寫好接口後,前臺就可以通過鏈接獲取接口提供的數據,而返回的數據一般分爲兩種情況,xml和json,在這個過程中,服務器並不知道,請求的來源是什麼,有可能是別人非法調用我們的接口,獲取數據,因此就要使用安全驗證。
原理
從圖中可以看得很清楚,前臺想要調用接口,需要使用幾個參數生成簽名。
時間戳:當前時間
隨機數:隨機生成的隨機數
口令:前後臺開發時,一個雙方都知道的標識,相當於暗號
算法規則:商定好的運算規則,上面三個參數可以利用算法規則生成一個簽名。
前臺生成一個簽名,當需要訪問接口的時候,把時間戳,隨機數,簽名通過URL傳遞到後臺。後臺拿到時間戳,隨機數後,通過一樣的算法規則計算出簽名,然後和傳遞過來的簽名進行對比,一樣的話,返回數據。
算法規則
在前後臺交互中,算法規則是非常重要的,前後臺都要通過算法規則計算出簽名,至於規則怎麼制定,看你怎麼高興怎麼來。
我這個算法規則是
時間戳,隨機數,口令按照首字母大小寫順序排序
然後拼接成字符串
進行sha1加密
再進行MD5加密
轉換成大寫。
前臺
這裏我並沒有實際的前臺,直接使用一個PHP文件代替前臺,然後通過CURL模擬GET請求。我使用的是TP框架,URL格式是pathinfo格式。
源代碼
源代碼
<?php
/**
* Created by PhpStorm.
* User: Administrator
* Date: 2017/3/16 0016
* Time: 15:56
*/
namespace Client\Controller;
use Think\Controller;
class ClientController extends Controller{
const TOKEN = 'API';
//模擬前臺請求服務器api接口
public function getDataFromServer(){
//時間戳
$timeStamp = time();
//隨機數
$randomStr = $this -> createNonceStr();
//生成簽名
$signature = $this -> arithmetic($timeStamp,$randomStr);
//url地址
$url = "http://www.apitest.com/Server/Server/respond/t/{$timeStamp}/r/{$randomStr}/s/{$signature}";
$result = $this -> httpGet($url);
dump($result);
}
//curl模擬get請求。
private function httpGet($url){
$curl = curl_init();
//需要請求的是哪個地址
curl_setopt($curl,CURLOPT_URL,$url);
//表示把請求的數據已文件流的方式輸出到變量中
curl_setopt($curl,CURLOPT_RETURNTRANSFER,1);
$result = curl_exec($curl);
curl_close($curl);
return $result;
}
//隨機生成字符串
private function createNonceStr($length = 8) {
$chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
$str = "";
for ($i = 0; $i < $length; $i++) {
$str .= substr($chars, mt_rand(0, strlen($chars) - 1), 1);
}
return "z".$str;
}
/**
* @param $timeStamp 時間戳
* @param $randomStr 隨機字符串
* @return string 返回簽名
*/
private function arithmetic($timeStamp,$randomStr){
$arr['timeStamp'] = $timeStamp;
$arr['randomStr'] = $randomStr;
$arr['token'] = self::TOKEN;
//按照首字母大小寫順序排序
sort($arr,SORT_STRING);
//拼接成字符串
$str = implode($arr);
//進行加密
$signature = sha1($str);
$signature = md5($signature);
//轉換成大寫
$signature = strtoupper($signature);
return $signature;
}
}
服務器端
接受前臺數據進行驗證
源代碼
<?php
/**
* Created by PhpStorm.
* User: Administrator
* Date: 2017/3/16 0016
* Time: 16:01
*/
namespace Server\Controller;
use Think\Controller;
class ServerController extends Controller{
const TOKEN = 'API';
//響應前臺的請求
public function respond(){
//驗證身份
$timeStamp = $_GET['t'];
$randomStr = $_GET['r'];
$signature = $_GET['s'];
$str = $this -> arithmetic($timeStamp,$randomStr);
if($str != $signature){
echo "-1";
exit;
}
//模擬數據
$arr['name'] = 'api';
$arr['age'] = 15;
$arr['address'] = 'zz';
$arr['ip'] = "192.168.0.1";
echo json_encode($arr);
}
/**
* @param $timeStamp 時間戳
* @param $randomStr 隨機字符串
* @return string 返回簽名
*/
public function arithmetic($timeStamp,$randomStr){
$arr['timeStamp'] = $timeStamp;
$arr['randomStr'] = $randomStr;
$arr['token'] = self::TOKEN;
//按照首字母大小寫順序排序
sort($arr,SORT_STRING);
//拼接成字符串
$str = implode($arr);
//進行加密
$signature = sha1($str);
$signature = md5($signature);
//轉換成大寫
$signature = strtoupper($signature);
return $signature;
}
}
結果
string(57) "{"name":"api","age":15,"address":"zz","ip":"192.168.0.1"}"
總結
這種方法只是其中的一種方法,其實還有很多方法都是可以進行安全驗證的。
php開發app接口需要注意什麼
1.制定規範
開發前一定要定好一個規範,比如要定好數據返回的通用參數和格式。關於數據格式,用的比較多的有xml和json,我建議用json,因爲json比xml的好處更多。
2.精簡的返回數據
接口數據因符合需要什麼返回什麼的原則,比如要查詢某個用戶的餘額和註冊時間,網頁裏面的做法可能是select * from user where uid=1,但是接口一定要select balance,regtime from user where uid=1。因爲接口返回數據是要有開銷的,要流量的,能少返回數據就儘量少返回,這樣可以大大的提高性能。
3.數據類型要嚴格
要注意數據的類型,整數類型的數據一定要轉爲int,因爲app客戶端開發的java、object-c語言對數據類型比較嚴格,類型不對會照成app閃退。
4.要寫接口文檔
一定要寫好接口文檔,並按照模塊寫,而且還要書寫規範,最好的格式是:
接口請求地址;請求參數(包括參數名、類型、是否必填);測試參數舉例;返回參數(參數名,並註明每個參數的含義)。
這樣哪怕以後項目很大,以不會照成維護困難的問題。
5.保證代碼正確性
要驗證保證代碼正確無誤,而且生成環境中要屏蔽掉錯誤,避免頭部有額外的輸出,照成返回的json等數據解析失敗而導致app閃退等。
6.要優化代碼的性能
app要求響應迅速,這樣才能給用戶比較好的體驗感。所以移動接口端在處理業務邏輯的時候,要避免不要執行太複雜的sql語句,或者含有大量的循環,能做成緩存的儘量做緩存,比如將首頁的熱點模塊信息可以存到redis緩存中。在不考慮網速的情況下,比較理想的接口響應時間應該是200毫秒以內。
7.不要隨意更改舊接口
app不像網頁,app一旦發佈,有人使用之後,接口就不要亂修改了。以後升級也是,修改要在保證接口原有結構之上進行額外的擴展,否則會導致調用舊版接口的app出現bug。
8. 注意接口的安全
安全高於一切,必須要保證接口的安全。電話號碼等敏感信息在傳輸的過程中一定要加密,否則可能會被別人抓包到。拿取用戶信息的接口一定要驗證權限,以防止接口被惡意調用,泄密用戶信息,甚至篡改信息。