在開始使用 API 之前,您應該先進行認證以建立會話。
認證方式:
有兩種方式可以啟動會話:
- 使用您的 API 金鑰、帳號及密碼詳細資料;
- 使用您的 API 金鑰、帳號及加密密碼詳細資料。
使用您的 API 金鑰、帳號及密碼詳細資料
這裡您只需使用 POST /session 端點,並在 X-CAP-API-KEY 標頭中提及在平台設定中取得的 API 金鑰,於 identifier 與 password 參數中填入帳號及 API 金鑰密碼資訊。encryptedPassword 參數的值應為 false。
使用您的 API 金鑰、帳號及加密密碼詳細資料
- 首先,您應該使用 GET /session/encryptionKey 並在 X-CAP-API-KEY 標頭中提及在平台設定中產生的 API 金鑰。回應中您將收到 encryptionKey 與 timeStamp 參數;
- 使用收到的 encryptionKey 與 timeStamp 參數,您應該使用 AES 加密方法加密您的 API 金鑰密碼。
- 接著,前往 POST /session 端點,將 encryptedPassword 參數設為 true,並在 X-CAP-API-KEY 標頭中提及在平台設定中取得的 API 金鑰,於 identifier 與 password 參數中填入帳號及先前加密過的 API 金鑰密碼資訊。
啟動會話後,您會在回應標頭中收到 CST 與 X-SECURITY-TOKEN 參數。這兩個令牌皆須用於您發送的每個請求標頭中。