OAuth 2.0 端点

EffiLink 支持 OAuth 2.0 授权码流程作为 ApiKey 认证的替代方案。使用以下两个端点获取访问令牌,该令牌可通过 OAuth 请求头传递到任何 API 请求。

授权 URL

将用户重定向到 EffiLink 授权同意页面。用户批准访问后,EffiLink 会带着短期授权码重定向回您的 redirect_uri。

查询参数

string

必填

在 EffiLink 平台中生成的 OAuth 应用 ID。

string

必填

必须为 code。这是唯一支持的值。

string

必填

URL 编码的回调 URL,用户批准后 EffiLink 会将授权码发送到此处。必须与您 OAuth 应用注册的重定向 URI 完全一致。

string

必填

必须为 All。这是唯一支持的作用域值。

响应

此端点不返回 JSON。它会发出 HTTP 重定向到 EffiLink 授权同意页面。用户批准授权请求后,EffiLink 将浏览器重定向到:

{redirect_uri}?code=AUTHORIZATION_CODE

授权码有效期为 5 分钟,只能使用一次。请立即使用获取访问令牌端点将其兑换为访问令牌。

curl --request GET \
  --url 'https://api.effilink.co/v5/auth/oauth/authorize?client_id=1751651162214168&response_type=code&redirect_uri=https%3A%2F%2Fyourapp.com%2Fcallback&scope=All'

获取访问令牌

用有效的授权码兑换访问令牌。此令牌用于后续 API 请求的 OAuth 请求头。

查询参数

string

必填

必须为 authorization_code。这是唯一支持的值。

string

必填

在 EffiLink 平台中生成的 OAuth 应用 ID。

string

必填

在 EffiLink 平台中生成的 OAuth 应用密钥。请对此值保密。

string

必填

在授权 URL 步骤的 redirect_uri 回调中收到的授权码。

响应

integer

成功时为 200。

string

成功时为 null;失败时为错误描述。

string

API 请求 OAuth 请求头中包含的访问令牌。最大长度为 512 字节。

integer

令牌剩余有效期(秒)。-1 表示令牌为永久有效且不会过期。当剩余时间少于 5 分钟(expiresIn < 300)时可以生成新令牌。在短暂的过渡窗口期内,新旧令牌同时有效,防止请求中断。

每个 API 密钥在其有效期内仅允许一个活动令牌。

curl --request GET \
  --url 'https://api.effilink.co/v5/auth/oauth/token?grant_type=authorization_code&client_id=1751651162214168&client_secret=YOUR_CLIENT_SECRET&code=AUTHORIZATION_CODE'

Response

{
  "code": 200,
  "message": null,
  "accessToken": "5cb089d6eafd49caa68c41b9be9af6f6",
  "expiresIn": -1
}

使用访问令牌

在任何 EffiLink API 请求的 OAuth 请求头中传入访问令牌:

curl --request POST \
  --url https://api.effilink.co/v5/transactional/mail/sends_customised \
  --header 'Content-Type: application/json' \
  --header 'OAuth: 5cb089d6eafd49caa68c41b9be9af6f6' \
  --data '{...}'

如果您不想实现 OAuth 流程,可以直接使用 ApiKey 请求头。所有 EffiLink API 端点都接受这两种认证方式。

事务性邮件

营销邮件

短信

联系人与名单

Webhooks

身份验证

授权 URL

查询参数

响应

获取访问令牌

查询参数

响应

使用访问令牌

​授权 URL

​查询参数

​响应

​获取访问令牌

​查询参数

​响应

​使用访问令牌

授权 URL

查询参数

响应

获取访问令牌

查询参数

响应

使用访问令牌