サービスアカウントを理解する

こちらの機能はリリース前のβ機能となります

導入を検討されているお客様は営業担当までお問い合わせください。
また、今後予告なく仕様変更を伴う機能改善が行なわれる可能性があります。ご了承ください。

サービスアカウントとは?

サービスアカウントは、KARTE 管理画面のアクセスに必要なユーザーアカウントとは異なり、あなたのアプリケーションが KARTE の API や Webhook を利用するためのアカウントです。KARTE の API や Webhook を利用するためには、サービスアカウントが必要となります。
サービスアカウントは主に次の役割を果たします。

  • API の認証と認可を行うための TokenScope を管理する。
  • KARTE で起こった変更を監視し、その情報を通知する Webhook を管理する。

認証と認可

認証とは、アクセスしたアカウントの身元が正しいかどうかを検証するプロセスです。ユーザーアカウントがメールアドレスとパスワードを利用して認証をおこなうように、サービスアカウントに特別な Token を発行し、それを認証に用います。Token はプロジェクト単位で発行されるため、API を利用するプロジェクト毎に Token を発行する必要があります。
Token と サービスアカウントの client_id、リクエストの body 部に含まれる api_key を検証し、正しい場合にのみ、API が実行されます。

一方、認可は、アカウントの機能へのアクセスが許可されているか検証します。開発者はサービスアカウントに Scope を定義することで、機能へのアクセスを制限することができます。
Scope に定義されていない API は、実行することができません。

API 一覧

利用可能な API 一覧は以下のとおりです

Event

Name
Description

Track

イベントを KARTE に送信し、ユーザーの解析を行います

Talk

Name
Description

Message

KARTE で解析されたユーザーにメッセージを送信します。メッセージの送信には、KARTE Talk で利用できるアプリケーションを指定することができます

Assign

KARTE Talk を通じてコミュニケーションが行われているユーザーの担当者 (オペレーター) を変更します

注意

サービスアカウントの定義では、上記のどの API についても Scope に定義することが可能ですが、それぞれ以下の条件を満たさない場合、API は実行されません。

Category
Name
Required Conditions

Talk

Message

KARTE Talk を利用可能であること。また、指定するアプリケーションタイプに対して、必要なプラグインがインストールされていること。詳細は こちら

Talk

Assign

KARTE Talk を利用可能であること

またリクエスト制限については こちら をご確認ください。

Webhook 一覧

Name
Description

Message

ウェブチャットで、エンドユーザーがチャットメッセージを送信したタイミングで、メッセージに関する情報を任意のエンドポイントURLに通知します

Assign

ウェブチャットで、担当者が変更されたタイミングで、新しい担当者の情報を任意のエンドポイントURLに通知します

ボットの定義

Talk の API を利用することで、外部のチャットボットと KARTE Talk のチャット機能 を繋げることができます。
各サービスアカウントに、ボットの定義をすることで、ユーザーが目にするチャットボットのプロフィールを登録することができます。
チャットボットと繋げるための詳細については こちら をご確認ください。


サービスアカウントを理解する


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.