Klaviyo API のスタートガイド

推定 1 分で読めます

更新日 2025年8月18日 0:00 EST

このページで学べること

API 呼び出しの基礎を理解し、Klaviyo の API がビジネスにもたらすメリットを把握しましょう。このガイドでは、REST API、HTTP メソッド、開発者ツールについて学び、Klaviyo の API をテストする準備を行います。最初の API コールは、開始から完了まで最短 10 分で実行できます。すでに API コールに慣れていて API のテストを開始する準備ができている場合は、Postman コレクションの使用方法に関するガイドに従ってください。

このガイドでは、新しい技術用語が導入されるたびに用語集へのリンクを掲載します。ガイド内で単語の意味が不明な場合は、技術用語集をご確認ください。

REST API とは何ですか？

REST APIは、Representational State TransferとApplication Programming Interfaceの略語です。これらの用語は、あるソフトウェアが別のソフトウェアとやり取りし、それらの間で情報を受け渡しできるようにする構造化されたリクエストとして、より簡単に理解できます。Klaviyo API呼び出しを行うと、サーバーにリクエストを送信し、レスポンスを受け取ります。レスポンスにはステータスコードが含まれ、エンドポイントがデータを返す場合は、JSON（JavaScript Object Notation）形式のボディも含まれます。成功したリクエストの中には、レスポンスボディが返されないものもあります。

より簡単に言うと、REST API を使用すると、Klaviyo に保存されているデータストアをリクエストし、人とコンピューターの両方が読み取れる形式でそのデータを返してもらうことができます。

データを取得するGETリクエストは、次の手順に従います：

インターネット経由で API に対して、データの構造化リクエストを送信します。リクエストは HTTP を介して送信されます。HTTP は基本的なネットワークリクエストタイプで、インターネットの大部分はこれを基盤として構築されています。
API はリクエストを受信して処理し、Klaviyo のデータベースから要求された情報を取得します。
次に API は、JSON 構造化形式を使用してクライアントアプリケーションに応答します。
クライアントアプリケーションから JSON レスポンスを受け取ります。

この知識はデータ転送の仕組みを理解するうえで役立ちますが、API呼び出しを始めて、Klaviyo APIが提供する機能から価値を得るために必須というわけではありません。以下のセクションでは基本事項を説明し、リンク先のPostmanガイドでは初めてのAPI呼び出しを手順に沿ってご案内します。

HTTP メソッド

HTTP メソッドは、リクエストの送信に使用される「動詞」です。このガイドでは、次の 2 つの HTTP メソッド（GET と POST）を取り上げます。

ここでは使用しませんが、多くの REST API は PUT、PATCH、DELETE などの追加の HTTP メソッドもサポートしている点は覚えておくとよいでしょう。

GET

GET リクエストは、「read」リクエストとして最も簡単に理解できます。GET リクエストは API エンドポイントから情報を取得し、JSON 形式のレスポンスで返します。これらのリクエストではデータの読み取りのみが可能で、この方法ではデータを変更したり上書きしたりできないため、最も安全な種類のリクエストです。

POST

POSTリクエストは、簡単に「書き込み」リクエストとして理解できます。POSTでは、新しいリソースを作成または追加できます。たとえば、Lists APIへのPOSTリクエストは、アカウント内に新しいリストを作成するために使用できます。一方、GETリクエストでは、リストをページごとに取得できます。ページがなくなるまで、各レスポンス内の次ページへのリンクに従ってください。

成功レスポンスについては、エンドポイントのリファレンスドキュメントを確認してください。リストを作成すると、新しいリストのデータとともに201（Created）が返されます。イベントの作成などの一部のPOSTリクエストでは、レスポンスボディなしで202（Accepted）が返されます。202レスポンスは、リクエストが処理のために受け付けられたことを意味します。処理が完了したことを確認するものではありません。

必要なツール

APIはワークフローに高い柔軟性をもたらし、目的の結果を得るために特定のクライアントアプリケーションや言語ライブラリを使用する必要はありません。API呼び出しはHTTPリクエストを使用して行われるため、ほぼすべてのプログラミング言語で、標準機能として、または広く利用可能な言語ライブラリを通じて、この種類のリクエストを送信できます。さらに、マシンとオペレーティングシステムに応じて、AppleのターミナルやWindowsターミナルなどのネイティブアプリケーションを使用して、コンピューターからAPI呼び出しを行うことができます。ただし、これらのアプリケーションを使用するには、コマンドラインインターフェイスに関する事前知識が必要です。

Postman という無料のウェブおよびデスクトップアプリケーションを使用します。Postman には、エンドポイント、パラメータ、認証を便利なユーザーインターフェースに入力して API リクエストを設定・送信しやすくするためのさまざまな機能があります。

Klaviyo の API をテストする

実験にはKlaviyoのテストアカウントを使用してください。POSTリクエストは、Postmanから送信した場合でも、認証情報に関連付けられたアカウント内のデータを変更する可能性があります。

プライベートAPIキーを使用するリクエストの場合は、テストする予定のエンドポイントで必要な権限を持つキーを作成してください。たとえば、リストを取得するにはlists:readが必要ですが、リストを作成するにはlists:writeが必要です。プライベートAPIキーは安全に管理し、ブラウザコードで決して公開しないでください。

Klaviyo の API は、他のプラットフォームやサーバーから Klaviyo アカウントへデータを送信したり、Klaviyo アカウント内の情報を照会したりする際に役立ちます。API の仕組みを理解できたので、ビジネスのユースケースに合わせて API のテストを開始できます。Klaviyo で利用可能な API の一覧については、API リファレンスドキュメントをご覧ください。最初の Klaviyo API 呼び出しを行うには、当社の Postman コレクションの使用方法に関するガイドに従ってください。