アプリを利用する

アプリ作成手順

サポートサイトを参考に、アプリを作成してください。

アプリ操作の権限について

アプリの閲覧・編集には、管理画面のアカウントに以下の権限が付与されている必要があります。

  • API v2の権限
    • API v2 設定の閲覧
    • API v2 設定の編集
  • Scope (後述) に対応する権限

権限の付与方法についてはサポートサイトをご覧ください。

アプリ作成時の各項目について

アプリタイプ

API を利用する目的に応じて、アプリタイプを選択してください。
各アプリタイプについては以下の通りです。

アプリタイプ利用場面
tokenKARTE が提供する API の機能を使ってお客様自身でアプリケーションを作成したいときに利用
botチャットボットを作成したいときに利用。APIの機能に加え、独自にBotの名前とアイコンを定義できます。
craftKARTE CraftのCraft Functionsでのみ利用できるアプリです。IP制限やKARTE Craft上で独自の認証を実装する場合はこちらのタイプを選んでください。

🚧

「アプリタイプ」は後から変更できません。

誤って作成した場合は、アプリを再度作成し直してください。

craft アプリタイプについて

📘

craft アプリタイプは KARTE Craft の Growth プラン以上でご利用になれます。

KARTE Craftのご契約・プラン変更については弊社の営業・サクセス担当者にお問い合わせください。

craft タイプのアプリは token タイプと同様にアクセストークンが発行されますが、KARTE Craft環境でのみ認証が可能となっています。具体的にCraft Functionsで利用する方法は karteApiClientForCraftTypeApp をご確認ください。

アプリ名

自由に設定することができます。任意のアプリ名をご記入ください。

説明

自由入力欄です。このアプリがどのように利用されるのか、などご自由に入力してください。

Scope

アプリに与える権限を選択できます。Scope と API は1対1で紐付きます。利用したい API の権限(Scope)を選択してください。必要な Scope については、各 API のリファレンスを参照ください。

アクセストークンについて

アクセストークンの発行方法

アプリを作成すると自動的にアクセストークンが発行されます。

🚧

アクセストークンはアプリ作成後に一度だけしか表示されません

アクセストークンを表示できるのは、アプリ作成時のみです。アクセストークンを後で復元することはできないのでご注意ください。アクセストークンを紛失した場合はアプリの再作成をしてください。

アクセストークンを無効化する

アプリを無効化するか削除することでアクセストークンを無効化できます。