KARTE Appsを理解する

🚧

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

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

KARTE Apps とは?

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

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

認証と認可

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

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

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

使用可能なAPIについてはリファレンス でご確認ください。

ボットの定義

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

Updated 10 months ago


KARTE Appsを理解する


Suggested Edits are limited on API Reference Pages

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