雲尚API

平台管理介面

平台 API 提供帳戶餘額查詢、實名狀態查詢、呼叫記錄查詢、產品列表查詢、銷售價格查詢、線上購買及訂單查詢等功能。所有介面透過統一入口呼叫,使用全域應用憑證進行認證,僅限銷售/管理員角色呼叫。

介面資訊

項目說明
介面位址POST /api.php
認證方式全域應用 APP ID / APP KEY
角色限制僅銷售/管理員
請求格式application/json
回應格式application/json

通用請求參數

參數類型必填說明
actionstring介面動作,見下方列表
app_idstring全域應用 APP ID
app_keystring全域應用 APP KEY

範例全域應用憑證(僅供文件參考,請替換為您的實際憑證):

app_id: 68B0FA47FEC9E7EBC4BF80F8
app_key: 2b901515a427b6c0b68f866eece70e0d2ecf687146022412

支援的 action 列表

action功能說明
balance查詢餘額回傳目前帳戶餘額
realname_status查詢實名狀態回傳是否已實名認證
products查詢產品列表回傳所有已啟用產品
sales_prices查詢銷售價格回傳產品原價及銷售價
orders查詢訂單回傳購買記錄(含專屬 APP 憑證)
call_logs查詢呼叫記錄回傳 API 呼叫日誌
buy線上購買按次購買套餐,回傳訂單及專屬憑證

通用回應結構

欄位類型說明
codeint狀態碼,0 表示成功
msgstring提示資訊
datamixed回應資料,具體結構依介面而定

錯誤碼

錯誤碼說明
0成功
1001參數錯誤
1002認證失敗
1003無權限(非銷售/管理員)
1004資源不存在
1005餘額不足
1006內部錯誤

注意事項

  • 所有請求必須使用 POST 方法,Content-Typeapplication/json
  • 全域應用憑證需在雲尚平台「應用管理」中建立,僅限銷售/管理員角色使用
  • 購買介面 buy 僅支援套餐制 API,買斷制 API 不支援按次購買
  • 訂單查詢與呼叫記錄支援分頁,limit 最大值為 50
  • 所有金額欄位均為 4 位小數精度
  • 專屬 APP ID 與 KEY 用於子應用登入與 API 呼叫,請妥善保管
  • 介面回傳 code 非 0 時,請依 msg 提示排查問題