雲尚API

快速開始

本節為使用教學的入口,目前先給出最核心的接入步驟,詳細的後台操作指南(餘額儲值、帳單查詢、套餐管理、回呼設定)正在整理中,後續會陸續補充。

第一步:註冊並建立應用

在後台註冊帳號後,進入「應用管理」建立一個應用。每個應用會產生獨立的 App IDApp Key,多個應用互不影響,適合區分不同業務線。

第二步:購買套餐

進入「套餐購買」頁面,選擇需要的介面與套餐類型:

  • 套餐制:按次數扣減,用完可續費,適合低頻或量小的呼叫
  • 買斷制:一次付費,按授權範圍長期使用(目前僅支付寶實名認證)
  • 第三步:呼叫介面

    取得憑證後,直接參照 平台介紹 的呼叫說明發送請求即可。最快的方式是先以 curl 驗證:

    curl -X POST https://yunsapi.com/api/v3/dxyzm \
      -H "X-APP-ID: YOUR_APP_ID" \
      -H "X-APP-KEY: YOUR_APP_KEY" \
      -H "Content-Type: application/json" \
      -d '{"phone":"13800138000"}'

    回傳 code0 即呼叫成功。

    注意事項

  • 正式環境請使用 HTTPS 存取
  • App Key 不要洩漏到前端頁面或公開儲存庫
  • 各介面的計費規則不同,呼叫前確認套餐剩餘次數
  • 更多教學內容整理中,敬請期待。