平台管理介面
平台 API 提供帳戶餘額查詢、實名狀態查詢、呼叫記錄查詢、產品列表查詢、銷售價格查詢、線上購買及訂單查詢等功能。所有介面透過統一入口呼叫,使用全域應用憑證進行認證,僅限銷售/管理員角色呼叫。
介面資訊
| 項目 | 說明 |
|---|
| 介面位址 | POST /api.php |
| 認證方式 | 全域應用 APP ID / APP KEY |
| 角色限制 | 僅銷售/管理員 |
| 請求格式 | application/json |
| 回應格式 | application/json |
通用請求參數
| 參數 | 類型 | 必填 | 說明 |
|---|
action | string | 是 | 介面動作,見下方列表 |
app_id | string | 是 | 全域應用 APP ID |
app_key | string | 是 | 全域應用 APP KEY |
範例全域應用憑證(僅供文件參考,請替換為您的實際憑證):
app_id: 68B0FA47FEC9E7EBC4BF80F8
app_key: 2b901515a427b6c0b68f866eece70e0d2ecf687146022412
支援的 action 列表
| action | 功能 | 說明 |
|---|
balance | 查詢餘額 | 回傳目前帳戶餘額 |
realname_status | 查詢實名狀態 | 回傳是否已實名認證 |
products | 查詢產品列表 | 回傳所有已啟用產品 |
sales_prices | 查詢銷售價格 | 回傳產品原價及銷售價 |
orders | 查詢訂單 | 回傳購買記錄(含專屬 APP 憑證) |
call_logs | 查詢呼叫記錄 | 回傳 API 呼叫日誌 |
buy | 線上購買 | 按次購買套餐,回傳訂單及專屬憑證 |
通用回應結構
| 欄位 | 類型 | 說明 |
|---|
code | int | 狀態碼,0 表示成功 |
msg | string | 提示資訊 |
data | mixed | 回應資料,具體結構依介面而定 |
錯誤碼
| 錯誤碼 | 說明 |
|---|
| 0 | 成功 |
| 1001 | 參數錯誤 |
| 1002 | 認證失敗 |
| 1003 | 無權限(非銷售/管理員) |
| 1004 | 資源不存在 |
| 1005 | 餘額不足 |
| 1006 | 內部錯誤 |
注意事項
所有請求必須使用 POST 方法,Content-Type 為 application/json
全域應用憑證需在雲尚平台「應用管理」中建立,僅限銷售/管理員角色使用
購買介面 buy 僅支援套餐制 API,買斷制 API 不支援按次購買
訂單查詢與呼叫記錄支援分頁,limit 最大值為 50
所有金額欄位均為 4 位小數精度
專屬 APP ID 與 KEY 用於子應用登入與 API 呼叫,請妥善保管
介面回傳 code 非 0 時,請依 msg 提示排查問題