開始使用

使用 API 金鑰進行驗證

除了兩個定價端點外,每個端點都需要在 Authorization 標頭中包含 API 金鑰。

POST /v1/messages HTTP/1.1
Host: bulksmsapi.cc
Authorization: Bearer bsa_live_7QzX2mW9kR4tB8nV1cJ6yP3sH5dL0aFe
Content-Type: application/json

建立金鑰

  • 金鑰在控制台的 API 金鑰頁面建立。該頁面在首次充值後開啟。
  • 一個帳號可以擁有 10 個有效金鑰。為每個應用程式或環境分配自己的金鑰和名稱,以便在不影響其他金鑰的情況下替換其中一個。
  • 金鑰以 bsa_live_ 開頭,後接 32 個字母和數字。它僅在建立時顯示一次;我們只保留金鑰的雜湊值,因此遺失的金鑰無法再次顯示。請建立一個新的金鑰。
  • 清單顯示金鑰的前幾個字元、最後四個字元、建立時間以及最後使用時間。

輪換與撤銷

要無停機時間輪換金鑰:建立第二個金鑰,部署它,在控制台中檢查其最後使用時間,然後撤銷舊金鑰。撤銷的金鑰從下一個請求開始會回應 401 unauthorized。

保護金鑰安全

  • 從您的伺服器呼叫 API,切勿從瀏覽器或行動應用程式呼叫:任何擁有金鑰的人都可以從您的餘額中發送訊息。
  • 將金鑰儲存在環境變數或秘密管理器中,而不是原始碼控制中。
  • 每個金鑰都有自己的速率限制計數器,因此忙碌的工作者不會減慢其他地方使用的第二個金鑰的速度。

錯誤

401 UnauthorizedJSON
{
  "error": {
    "code": "unauthorized",
    "message": "Send your API key as Authorization: Bearer bsa_live_... Keys are created in the console under API keys.",
    "doc_url": "https://bulksmsapi.cc/en/docs/errors#unauthorized"
  }
}
使用 API 金鑰進行驗證 | BulkSMSAPI 文件