Currencycloud API 中的所有端點都需要進行身份驗證。您無需在每次請求時提供使用者名稱和 API 密鑰,只需登入一次即可獲取臨時身份驗證令牌。
工作流程圖
基本 URL
環境 | 基本 URL |
---|---|
演示 | devapi.currencycloud.com |
生產 | api.currencycloud.com |
身份驗證指南
1.登入
調用登入端點 (/v2/authenticate/api
),傳入您的 Currencycloud 登入 ID(通常是您的電子郵件地址)和您唯一的 API 密鑰。如果您還沒有 API 密鑰,可在此處註冊。我們將向您發送一封電子郵件,說明如何獲取 API 密鑰。
POST /v2/authenticate/api Content-Type: multipart/form-data
參數名稱 | 參數類型 | 示例值 |
---|---|---|
api_key |
表單資料 | 1f6a3e944f8c4ebdc6658d6fc1103f12ebbc33f5ed05ca3549fdbc3883556544 |
login_id |
表單資料 | your.login@example.com |
如果您的憑證通過驗證,回應有效負載將包含新的身份驗證令牌。
HTTP/1.1 200 OK Content-Type: application/json { "auth_token": "ea6d13c7bc50feb46cf978d137bc01a2" }
2.保留身份驗證令牌
從回應有效負載中提取 auth_token
。這就是您的身份驗證令牌。從現在開始,您的身份驗證令牌將用作您登入憑證的代理。您需要在所有後續 API 調用中提交您的身份驗證令牌。您可透過 X-Auth-Token
標頭執行此操作。
示例:
POST /v2/beneficiaries/create HTTP/1.1 X-Auth-Token: ea6d13c7bc50feb46cf978d137bc01a2
身份驗證令牌在 30 分鐘未使用後即過期。當您的身份驗證令牌過期時,Currencycloud API 服務會回傳此回應:
HTTP/1.1 401 Unauthorized Content-Type: application/json { "error_code": "auth_failed", "error_messages": { "username": [ { "code": "invalid_supplied_credentials", "message":"Authentication failed with the supplied credentials", "params": {} } ] } }
在這種情況下,您應透過再次調用登入端點 (/v2/authenticate/api) 來請求新的身份驗證令牌。
我們建議您等到當前的身份驗證令牌過期後再重新進行身份驗證。
3.登出
良好的安全做法是在不再需要身份驗證令牌時將其作廢,而非任其過期。向登出端點 (/v2/authenticate/close_session) 發送請求以立即終止身份驗證令牌。
POST /v2/authenticate/close_session X-Auth-Token: ea6d13c7bc50feb46cf978d137bc01a2