PbootCMS用於遠端調取系統資料API介面列表

黄文Rex發表於2024-08-16
bootAPI

標籤作用：用於遠端調取系統資料。

使用說明

  • 1）請先到後臺進行API相關引數配置，強烈建議啟用強制認證；
  • 2）客戶端發起請求必須包含appid（認證使用者）、timestamp（時間戳）、signature（簽名）三個引數
  • 3）簽名引數signature透過appid、secret、timestamp三個值連線為一個字串,然後進行雙層md5加密生成;

站內使用Ajax獲取資料示例：

 <script>   
 $(document).ready(function (e) {     
  var url='/api.php/cms/site';  
  $.ajax({     
 type: 'POST',   
  url: url,  
  dataType: 'json',  
data: {     
appid: '{pboot:appid}',    
timestamp: '{pboot:timestamp}',   
  signature: '{pboot:signature}'      
       },         
 success: function (response, status) {  
if(response.code){      //獲取資料成功           
       alert(response.data.title); 
   }else{      //返回錯誤資料               
   alert(response.data);    
      }         
    },         
   error:function(xhr,status,error){    
         //返回資料異常       
        alert('返回資料異常！');      
      }    
   });  
 });    

 </script>

此處使用了三個站內標籤：{pboot:appid} 認證使用者名稱、{pboot:timestamp} 時間戳、{pboot:signature} 認證簽名 #### 1、網站資訊介面

http://IP/api.php/cms/sitehttp://IP/api.php/cms/site/name/*  單個呼叫

注意此處和CMS標籤比不帶site字首，所以返回整體資料和調取單個時直接寫名稱，如：標題title #### 2、公司資訊介面

http://IP/api.php/cms/company  http://IP/api.php/cms/company/name/* 單個呼叫

注意此處和CMS標籤比不帶company字首，所以返回整體資料和調取單個時直接寫名稱，如：名稱name #### 3、自定義標籤介面

http://IP/api.php/cms/label  http://IP/api.php/cms/label/name/*  單個呼叫

4、欄目列表樹介面

http://IP/api.php/cms/nav  http://IP/api.php/cms/nav/scode/*   獲取指定分類的子類

5、當前欄目位置介面

http://IP/api.php/cms/position/scode/*  此處傳遞當前欄目scode值

6、指定分類資訊介面

http://IP/api.php/cms/sort/scode/* 此處傳遞需要呼叫欄目的scode值

7、指定內容多圖介面

http://IP/api.php/cms/pics/id/*  此處傳遞內容ID值

8、幻燈片介面

http://IP/api.php/cms/slide/gid/*/num/*  此處傳遞分組gid及調取的數量num值，預設num為5

9、友情連結介面

http://IP/api.php/cms/link/gid/*/num/*  此處傳遞分組gid及調取的數量num值,預設num為10

10、指定內容列表介面

http://IP/api.php/list/*  此處傳遞需要呼叫的欄目scodehttp://IP/api.php/list/*/page/2 調取第二頁，如果資料已獲取完，返回類似{"code":0,"data":"已經到底了！","rowtotal":"5"}

同時還支援URL中傳遞num/*引數控制數量，傳遞order/* 控制排序方式，用POST方式會更好傳遞值 #### 11、指定內容詳情介面

http://IP/api.php/content/*  傳遞需要呼叫的內容ID(單頁一樣適用)

12、指定單頁詳情介面

http://IP/api.php/about/*  傳遞需要呼叫的單頁scode

13、搜尋內容介面

http://IP/api.php/cms/search   建議使用POST提交,keyword傳遞搜尋關鍵字單條件搜尋同時支援傳遞num/*引數控制數量，傳遞order/* 控制排序方式，建議POST方式可傳遞引數 field指定欄位，多個用|隔開；可傳遞引數 scode指定分類，多個用逗號隔開；可傳遞引數 fuzzy等於0關閉模糊匹配，另外也可使用多資料庫欄位名稱傳遞值來多條件搜尋

14、留言提交介面

http://IP/api.php/cms/addmsg  要求POST提交，傳遞的欄位同後臺自定義的留言欄位

15、留言內容介面

http://IP/api.php/cms/msg/num/*   傳遞num分頁大小http://IP/api.php/cms/msg/num/*/page/2   調取第二頁

16、表單提交介面

http://IP/api.php/cms/addform/fcode/*  要求POST提交,fcode為表單編碼，傳遞的欄位同後臺自定義的欄位

17、表單資料讀取介面

http://IP/api.php/cms/form/fcode/*     傳遞fcode表單編碼http://IP/api.php/cms/form/fcode/*/num/*/page/*   num控制條數，page控制頁碼

溫馨提示：

以上介面對於多語言（區域）的情況，請地址中附加acode引數指定語言,否則呼叫預設語言

相關文章