API v2は、KARTEを外部システムから操作するためのREST APIです。
管理画面以外から、自社システムや外部サービスと連携してKARTEのデータを取得・更新できます。
この記事の対象読者についてこの記事は、API v2を使ってシステム連携を実装する方向けです。
概要や利用の流れだけを知りたい方は、サポートサイトの「API v2の概要」をご確認ください。
API v2 を利用する前に
API v2を利用する前に、次の点を確認してください。
- API v2の利用のご利用には契約が必要です。 ご検討されている場合は、営業担当までお問い合わせください。
- 管理画面でアプリを作成し、アクセストークンを発行します。手順はサポートサイトの「アプリを利用する」をご確認ください。
- APIにはエンドポイントごとのリクエスト回数制限があります。詳細は「APIのリクエスト回数制限」をご確認ください。
- 提供ステータスがβ版のエンドポイントを利用する場合は、KARTE β機能トライアル利用規約への同意が必要です。詳細は「提供ステータス」をご確認ください。
認証と Scope
- リクエスト先のURLや、リクエストに必要なアクセストークンについては「Request」をご確認ください。
- 各エンドポイントの実行には、対応するScopeが必要です。利用したいAPIのScopeをアプリに付与してください。必要なScopeと、管理画面でScopeを追加する際に必要なKARTE管理画面の権限は、各APIリファレンスをご確認ください。
利用できる API
- API v2では、イベント・ユーザー情報・接客（キャンペーン／アクション）・Talk・Datahub・Craft など、KARTEの各機能を操作できます。利用可能なエンドポイントの一覧と詳細は、このDeveloper PortalのAPIリファレンスをご確認ください。
- エンドポイントごとのリクエスト回数制限は「APIのリクエスト回数制限」をご確認ください。
- レスポンスのステータスコードは「Response」をご確認ください。