Klaviyo とアプリ間の情報のやり取りを理解する

このページで学べること

API（アプリケーション プログラミング インターフェース）を介して、Klaviyo とサードパーティアプリ間で情報がどのように同期されるかについて説明します。Klaviyo の外部連携を介して交換されるほとんどのデータは一方向です。データは Klaviyo アカウントに取り込まれ、顧客データの幅広い範囲を活用できます。

外部連携が Klaviyo との間で情報を同期する仕組み

Klaviyo の API は、Klaviyo と Klaviyo アカウントに接続された他のアプリケーションとの間でデータをやり取りするための一連のインターフェイスです。Klaviyo を別のアプリケーションと初めて連携するには、OAuth で認証するか、API キーを使用する必要があります。API キーは、特定のアカウントに紐づく一意の識別子です。

Klaviyoは2種類のAPIキーを生成します。どちらもアカウントで確認できます：

• 公開
  公開 API キー（サイト ID と呼ばれる場合もあります）は、Klaviyo アカウントの一意の識別子です。このキーを第三者アプリが使用して、Klaviyo アカウント内の非公開情報にアクセスすることはできません。
• 非公開
  非公開APIキーを使用すると、選択した権限（スコープ）に応じて、リストなどKlaviyoアカウント内のデータをアプリケーションから読み取ったり変更したりできます。各アプリケーションには、必要なアクセス権限のみを付与してください。非公開APIキーはパスワードのように扱ってください。安全な場所に保管し、公開しないようにしてください。作成時に、各キーを安全な場所にコピーしてください。再度、その全体の値を表示することはできません。Klaviyoアカウントに追加されるデータのソースを追跡できるように、異なるアプリケーションごとに新しい非公開APIキーを生成できます。

Klaviyo API キーの種類に関するより詳細な情報については、API リファレンス ドキュメントをご覧ください。

Klaviyo の REST API

RESTは、インターネット上のアプリケーション間で、プラットフォームに依存しない通信を行うためのガイドラインを提供するアーキテクチャスタイルです。KlaviyoのREST APIは主に、JavaScript Object Notation（JSON）形式を使用して通信します。これは、APIメッセージに含まれる情報に構造化されたレイアウトを提供します。Klaviyoアカウントの以下の領域には、REST APIを介してアクセスできます：

• アカウント
• キャンペーン
• カタログ
• クーポン
• データプライバシー
• イベント
• フロー
• 画像
• リスト
• メトリック
• プロファイル
• レポート作成
• セグメント
• タグ
• テンプレート

上記のAPIはサーバーサイドアプリケーションから呼び出すことを想定していますが、顧客のウェブブラウザなどのクライアントサイドアプリケーションからイベントや購読を作成するためのClient APIも用意しています。Client APIリクエストには、公開APIキー（site ID）を使用してください。クライアントサイドコードで秘密APIキーを公開しないでください。

Klaviyo JavaScript オブジェクト

klaviyoオブジェクトは、従来の_learnqオブジェクトと_klOnsiteオブジェクトに置き換わります。これらのJavaScriptオブジェクトは、APIを操作してイベントをKlaviyoに送信するための簡略化された方法を提供します。klaviyoオブジェクトを使用すると、既知のプロファイルを識別し、ウェブサイト上のイベントとアクションを追跡できます。

その他のリソース