API v2は、管理画面外からKARTEを操作するための仕組みです。
「REST API」という方式を使い、プログラムや対応サービスからKARTEのデータを取得・更新できます。
自社システムや外部サービスと、リアルタイムに近い形で連携できます。
各APIのエンドポイントやリクエスト形式などの詳細は、Developer PortalのAPIリファレンスをご確認ください。
補足
API v2の利用をご検討される場合は、営業担当までお問い合わせください。
API v2でできること
API v2では、次のリソースを操作できます。
| リソース | できる操作 | Developer Portal |
|---|---|---|
| イベント | 送信、取得、送信とサーバーサイドアクションの実行 | APIリファレンス |
| ユーザー情報 | 統計情報の取得 | APIリファレンス |
| 紐付けテーブル | 行の追加・更新、削除 | APIリファレンス |
| 接客キャンペーン | 作成、取得、更新、公開・非公開、設定と効果の取得 | APIリファレンス |
| 接客アクション | 作成、取得、更新 | APIリファレンス |
| アクションテーブル | レコードの追加・変更、削除 | APIリファレンス |
| Talk / 担当者 | 担当者の取得、変更、解除 | APIリファレンス |
| Talk / メッセージ | メッセージの取得、送信 | APIリファレンス |
| Talk / ノート | ノートの取得、送信 | APIリファレンス |
| Talk / オペレーター | オペレーター情報の取得、一覧取得 | APIリファレンス |
| Talk / 対応ステータス | 対応ステータスの変更 | APIリファレンス |
| Datahub / ジョブフロー | 取得、実行 | APIリファレンス |
| Craft / Functions | 作成、更新、削除、一覧取得、メタデータ・コードの取得 | APIリファレンス |
| Craft / Sites | コンテンツの取得・アップロード・削除、公開状態の更新、サイト一覧の取得など | APIリファレンス |
| Craft / Cross CMS | コンテンツ・アセット・コレクション・モデルなどの作成・取得・更新・削除・公開 | APIリファレンス |
| アカウント | 一覧取得、招待、削除 | APIリファレンス |
| 権限グループ | 一覧取得、作成、削除 | APIリファレンス |
利用できるエンドポイントやリクエスト回数の制限は、Developer PortalのAPIのリクエスト回数制限をご確認ください。
API v2の使い方
API v2を利用するには、管理画面でアプリを作成し、アクセストークンを発行します。
アプリの作成手順や設定は、「アプリを利用する」をご確認ください。