跳至主要內容

公開 API

建立 API 金鑰並選好權限範圍

在這把金鑰要工作的那個工作區裡建立它,只給整合真正需要的權限範圍,並把它當作機密保管。金鑰只顯示一次——弄丟了就撤銷,再簽發一把新的。

步驟

  1. 在它將要碰到其中程式碼的那個工作區內部建立金鑰。金鑰不跨工作區。
  2. 給出整合仍能跑通的最窄權限範圍——唯讀就只給唯讀。
  3. 立刻把金鑰抄進你的機密保管庫。
  4. 按用戶端的方便,用 Bearer 權杖或 X-Mosaqo-API-Key 標頭做驗證。
  5. 能按位址限制就限制,並按計畫輪替。

如何驗證結果

呼叫一個身分類端點,例如 /me。它應當回傳你預期的那個工作區,這同時也確認了金鑰在哪裡生效。

常見的出錯之處

  • 被提交進程式碼庫、或貼在群組聊天裡的金鑰。
  • 一把無所不能的金鑰被所有整合共用。
  • 在錯誤的工作區裡建立的金鑰,隨後對什麼都回傳 403。
這篇文章解決了你的問題嗎

這沒有幫上忙

請寫信給我們,附上平台與版本、你走過的步驟、期望的結果,以及相關的工作區或 QR Code。附上任何東西之前,請先遮蔽全部機密資訊。

寫信給支援團隊