你可以在請求中提供 API 金鑰之一來認證 Ragic API。API 金鑰具有許多權限,因此請務必保密!
當你的程式通過 API 金鑰訪問 Ragic 時,將基本上以 API 金鑰使用者的身份登錄並執行讀寫操作。我們強烈建議為 API 金鑰訪問建立一個單獨的使用者帳號。這樣 API 訪問才不會與其他使用者混淆,能讓系統審計追蹤更方便,也將使你的 API 程式除錯更加容易。
API 認證是通過 HTTP 基本認證進行的。提供你的 API 金鑰作為基本身份驗證的使用者名稱,不需要提供密碼。
所有 API 請求必須通過 HTTPS 進行。通過普通 HTTP 發出的請求會失敗。你必須為所有請求進行身份驗證。
curl https://www.ragic.com/demo/sales/1\ --get -d api \ -H "Authorization:Basic YOUR_API_KEY_GOES_HERE"
請注意,HTTP 標頭名稱為 Authorization,值是你的 API 金鑰,前面帶有 "Basic ",Basic 後面有一個空格,你可能需要根據你的 Ragic 帳號 URL 將 URL 中的 www 修改為 na3、ap5 或 eu2等。
你可以在個人設定中產生你的 API 金鑰。
大多數 HTTP 用戶端(包括網頁瀏覽器)會顯示一個對話框或提示你提供用於 HTTP 基本認證的使用者名稱和密碼(留空)。大多數用戶端還允許你在 URL 中提供憑證。
如果由於某種原因你無法將 API 金鑰作為 HTTP 標頭或基本身份驗證發送,你可以將 API 金鑰作為參數名為 APIKey 發送。你需要為你發送的每個請求增加此參數。
curl https://www.ragic.com/demo/sales/1\ --get -d api \ -d "APIKey=YOUR_API_KEY_GOES_HERE"