验证

Currencycloud API 中的所有端点都需要验证。为了避免每次请求都提供用户名和 API 密钥，您只需登录一次即可获取临时验证令牌。

工作流程图

基础 URL

验证指南

1.登录

调用 Login 端点 (/v2/authenticate/api)，传入您的 Currencycloud 登录 ID（通常是您的电子邮件地址）和唯一的 API 密钥。如果您还没有 API 密钥，可以在此处注册。随后，您将收到一封电子邮件，里面包含获取 API 密钥的说明。

POST /v2/authenticate/api
Content-Type: multipart/form-data

如果您的凭据经过验证，则响应负载将包含新的验证令牌。

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": {}
      }
    ]
  }
}

在这种情况下，您应该再次调用 Login 端点 (/v2/authenticate/api) 来请求一个新的验证令牌。

我们建议您等待验证令牌过期后再进行重新验证。

3.登出

当不再需要验证令牌时，出于安全考虑，最好主动撤销验证令牌，而不是等待其过期。您可以发送请求到 Logout 端点 (/v2/authenticate/close_session) 来立即终止验证令牌。

POST /v2/authenticate/close_session
X-Auth-Token: ea6d13c7bc50feb46cf978d137bc01a2