OAuth를 사용한 계정 연결

OAuth 연결 유형은 두 가지 업계 표준 OAuth 2.0 흐름, 즉 암시적 및 승인 코드 흐름을 지원합니다.

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
• The token exchange endpoint, which is responsible for two types of exchanges:
  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

Note: Please choose which OAuth 2.0 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

OAuth 계정 연결 구현

참고: 재무 정보를 처리하기 위해 계정 연결을 구현하는 경우 작업에 추가 정책이 적용될 수 있습니다. 계정 연결이 포함된 작업을 검토하여 금융 정보를 검토하는 데 최대 6주가 걸릴 수 있으므로 출시 일정을 계획할 때 이 시간을 고려하세요. 검토 프로세스를 쉽게 하려면 검토를 위해 작업을 제출하기 전에 금융 서비스 정책을 준수하는지 확인하세요.

프로젝트 구성

OAuth 연결을 사용하도록 프로젝트를 구성하려면 다음 단계를 따르세요.

1. Actions Console을 열고 사용할 프로젝트를 선택합니다.
2. 개발 탭을 클릭하고 계정 연결을 선택합니다.
3. 계정 연결 옆에 있는 스위치를 사용 설정합니다.
4. 계정 생성 섹션에서 아니요, 내 웹사이트에서만 계정 생성을 허용하고 싶습니다를 선택합니다.

5. 연결 유형에서 OAuth 및 암시적을 선택합니다.

   

6. 클라이언트 정보:

   • Actions에서 Google에 발행한 클라이언트 ID에 값을 할당하여 Google에서 수신되는 요청을 식별합니다.
   • 승인 및 토큰 교환 엔드포인트의 URL을 삽입합니다.

참고: 클라이언트 ID를 base64 인코딩 문자열로 전송하려면 클라이언트 구성 (선택사항) 옆의 드롭다운 화살표를 클릭하고 Google에서 HTTP 기본 인증 헤더를 통해 clientID와 보안 비밀을 전송합니다 체크박스를 선택합니다.

6. 저장을 클릭합니다.

OAuth 서버 구현

为了支持 OAuth 2.0 隐式流程，您的服务会进行授权 端点。此端点负责 就数据访问征得用户同意。授权端点 向尚未登录的用户显示登录界面，并记录 同意所请求的访问。

当您的 Action 需要调用您的某项授权的 API 时，Google 会使用 此端点来获得用户许可，以在其上调用这些 API 。

由 Google 发起的典型 OAuth 2.0 隐式流会话具有以下特征： 以下流程：

1. Google 会在用户的浏览器中打开您的授权端点。通过 如果用户尚未登录，则可以登录，并且授予 Google 访问 通过您的 API 访问其数据（如果尚未授予权限）。
2. 您的服务会创建一个访问令牌并将其返回给 通过使用访问令牌将用户的浏览器重定向回 Google， 附件。
3. Google 调用您的服务的 API，并使用 。您的服务会验证访问令牌是否向 Google 授予 访问 API 的授权，然后完成 API 调用。

处理授权请求

当您的 Action 需要通过 OAuth 2.0 隐式流程执行账号关联时， Google 会通过包含以下内容的请求将用户发送到您的授权端点： 以下参数：

授权端点参数
client_id	您分配给 Google 的客户 ID。
redirect_uri	此请求的响应发送到的网址。
state	将一个在 重定向 URI。
response_type	要在响应中返回的值的类型。对于 OAuth 2.0 隐式 则响应类型始终为 token。

例如，如果您的授权端点可通过 https://myservice.example.com/auth 访问， 请求可能如下所示：

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

为了让授权端点能够处理登录请求，请执行以下步骤：

1. 验证 client_id 和 redirect_uri 值， 防止向意外或配置错误的客户端应用授予访问权限：

   • 确认 client_id 是否与您的客户端 ID 匹配 分配给 Google。
   • 确认 redirect_uri 指定的网址 参数的格式如下：

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID

     YOUR_PROJECT_ID 是项目设置页面上的 ID Actions 控制台界面。

2. 检查用户是否已登录您的服务。如果用户未登录 中，完成服务的登录或注册流程。

3. 生成 Google 将用于访问您的 API 的访问令牌。通过 访问令牌可以是任何字符串值，但必须唯一地表示 令牌对应的用户和客户端，且不得被猜到。

4. 发送 HTTP 响应，将用户浏览器重定向到相应网址 由 redirect_uri 参数指定。添加所有 以下参数：

   • access_token：您刚刚生成的访问令牌
   • token_type：字符串 bearer
   • state：原始状态的未修改状态值 请求 以下是生成的网址示例：

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google 的 OAuth 2.0 重定向处理程序将收到访问令牌并确认 state 值没有更改。在 Google 获得 访问令牌，则 Google 会将该令牌附加到后续调用 作为 AppRequest 的一部分添加到您的 Action。

인증 흐름을 위한 음성 사용자 인터페이스 설계

경고: 작업과의 대화를 시작할 때는 필수 계정 연결 메시지를 사용자에게 제공하지 마세요. 대신 인증되지 않은 사용자에게 작업이 작동하는 방식을 보여주는 게스트 흐름을 제공하고 진행에 필요한 경우에만 계정 연결을 요청하세요. 계정 연결 문제로 인해 사용자가 지속적으로 작업을 종료하는 경우 Google에서 작업을 적극적으로 홍보하지 않으므로 작업의 사용자 트래픽이 줄어들 수 있습니다.

참고: 계정 연결을 구현하는 작업을 빌드하려면 작업 빌더를 사용해야 합니다.

사용자가 인증되었는지 확인하고 계정 연결 흐름을 시작합니다.

1. Actions 콘솔에서 Actions Builder 프로젝트를 엽니다.
2. 작업에서 계정 연결을 시작할 새 장면을 만듭니다.
   1. 장면을 클릭합니다.
   2. add (+) 아이콘을 클릭하여 새 장면을 추가합니다.
3. 새로 만든 장면에서 조건의 추가 아이콘을 클릭합니다.
4. 대화와 연결된 사용자가 인증된 사용자인지 확인하는 조건을 추가합니다. 검사에 실패하면 작업이 대화 중에 계정 연결을 실행할 수 없으며 계정 연결이 필요하지 않은 기능에 대한 액세스 권한을 제공하는 것으로 대체됩니다.
   1. 조건의 Enter new expression 필드에 다음 로직을 입력합니다. user.verificationStatus != "VERIFIED"
   2. Transition에서 계정 연결이 필요하지 않은 장면이나 게스트 전용 기능의 진입점인 장면을 선택합니다.

1. 조건의 추가 아이콘을 클릭합니다.
2. 사용자에게 연결된 ID가 없는 경우 계정 연결 흐름을 트리거하는 조건을 추가합니다.
   1. 조건의 Enter new expression 필드에 다음 로직을 입력합니다. user.verificationStatus == "VERIFIED"
   2. Transition에서 Account Linking 시스템 장면을 선택합니다.
   3. 저장을 클릭합니다.

저장하면 <SceneName>_AccountLinking라는 새 계정 연결 시스템 장면이 프로젝트에 추가됩니다.

계정 연결 장면 맞춤설정

1. Scenes(장면)에서 계정 연결 시스템 장면을 선택합니다.
2. 메시지 보내기를 클릭하고 작업에서 사용자 ID에 액세스해야 하는 이유를 설명하는 짧은 문장을 추가합니다 (예: '환경설정 저장').
3. 저장을 클릭합니다.

1. 조건에서 사용자가 계정 연결을 완료한 경우를 클릭합니다.
2. 사용자가 계정 연결에 동의하는 경우 흐름을 어떻게 진행할지 구성합니다. 예를 들어 웹훅을 호출하여 필요한 맞춤 비즈니스 로직을 처리하고 원래 장면으로 다시 전환할 수 있습니다.
3. 저장을 클릭합니다.

1. 조건에서 사용자가 계정 연결을 취소하거나 닫은 경우를 클릭합니다.
2. 사용자가 계정 연결에 동의하지 않는 경우 흐름을 진행하는 방법을 구성합니다. 예를 들어 확인 메시지를 보내고 계정 연결이 필요하지 않은 기능을 제공하는 장면으로 리디렉션합니다.
3. 저장을 클릭합니다.

1. 조건에서 시스템 또는 네트워크 오류가 발생한 경우를 클릭합니다.
2. 시스템 또는 네트워크 오류로 인해 계정 연결 흐름을 완료할 수 없는 경우 흐름을 진행하는 방법을 구성합니다. 예를 들어 확인 메시지를 보내고 계정 연결이 필요하지 않은 기능을 제공하는 장면으로 리디렉션합니다.
3. 저장을 클릭합니다.

데이터 액세스 요청 처리

Assistant 요청에 액세스 토큰이 포함되어 있으면 먼저 액세스 토큰이 유효하고 만료되지 않았는지 확인한 후 데이터베이스에서 연결된 사용자 계정을 검색합니다.