OAuth 2 认证

更新时间：2024-11-03 09:13

OAuth 2 身份验证为开发者提供了一种安全的方式，代表EffiLink用户访问 EffiLink API 数据。OAuth 2 身份验证最常见的用途是设置第三方应用程序与EffiLink之间的集成,从而将您的应用程序数据与EffiLink同步，以便EffiLink可以发送营销或者交易邮件。

在本指南中，我们将逐步介绍如何设置 OAuth 2 来验证应用程序用户的身份，然后演示如何使用 OAuth 2 访问令牌调用 Marketing API。

前提条件

了解 OAuth 2 的基础知识，包括：

• 授权服务器
• 客户端应用程序
• 资源所有者
• 访问令牌

授权您的应用程序

授权您的应用程序以获取 OAuth 凭据。

授权过程中使用的client_id（应用Id）、client_secret（应用密钥）、redirect_uri（重定向地址）需要在平台配置：

OAuth 2 流程

使用步骤：

1. 用户安装了您的应用程序（您的App）。
   
2. 用户访问您的App，您的App加载EffiLink的授权弹出窗口。
   
3. 用户选择是否同意授权。
   
4. 若用户同意授权，则EffiLink将用户重定向到第一步指定的重定向URI，同时附上一个授权码（code）。
   
5. 第三方服务收到授权码（code），向EffiLink申请凭证（AccessToken）。
   
6. EffiLink检查授权码（code）的有效性，通过后颁发凭证（AccessToken）。
   
7. 第三方服务通过此凭证（AccessToken）访问EffiLink的业务 API。
   

OAuth 2 集成指南

在您的应用程序中实现 OAuth 2 身份验证

本指南演示如何在应用程序中实现 OAuth 2 身份验证。开始之前，请先熟悉EffiLink使用的 OAuth 2 流程。

第一步：构造EffiLink的OAuth 2 授权页链接

GET /v5/auth/oauth/authorize

请求参数

请求示例

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

请求返回
返回EffiLink授权页。
用户在授权页授权后，将重定向到传递的redirect_uri参数值，并且携带code参数。注意，code的有效期为5分钟。

第二步：通过授权码（code）获取凭证（AccessToken）

GET /v5/auth/oauth/token

请求参数

请求示例

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

返回参数

返回示例

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

第三步：使用凭证（AccessToken）访问 API

请求时请添加以下Header来身份验证：

示例

curl --request POST \
  --url https://api.effilink.co/v5/transactional/mail/sends_customised \
  --header 'OAuth: 5cb089d6eafd49caa68c41b9be9af6f6'
  --data ...