Loading
この記事では、APIキーの生成方法や実行できる操作など、systeme.ioの公開APIを設定して使用する方法について説明します。
1. APIとは？
APIとは「Application Programming Interface」の略で、あるプラットフォームが他のプラットフォームにサービスを提供するための一連の指示を指します。外部の開発者が、プラットフォームの特定の機能やデータに体系的かつ安全な方法でアクセスできるようにするための戦略的な窓口です。新しいアプリケーション、サービス、またはそれらを組み合わせた仕組みを簡単に構築できる、すぐに利用可能なツールセットのようなものです。
つまり、systeme.ioは、付加価値を提供できる分野において、そのサービスを他のプラットフォームにも開放しています。
2. 公開APIはどのように機能しますか？
当社のAPIでは、厳選された機能を公開しており、開発者は当社のプラットフォームと分かりやすく効率的に連携できます。仕組みについて詳しく知りたい場合は、公式のAPIドキュメントをご確認ください。
3. APIキーを生成する方法
APIキーは、公開APIへのリクエストを認証するための固有の識別子です。APIキーを使用することで、当社のプラットフォーム上のさまざまなリソースにプログラムからアクセスして管理できます。
公開APIキーを作成するには、プロフィール画像をクリックし、設定（1）を選択して、MCP＆APIキー（2）まで下にスクロールします。
作成（3）をクリックして、公開APIキーの作成を開始します。
公開APIキーを作成するポップアップで、名前を入力し、APIキーの有効期限の日付と時刻を選択します。
完了したら、保存（4）をクリックします。
注：APIキーを無期限に有効にしておくには、「有効期限」の設定欄を空欄のままにしてください。
これでキーを使用できるようになりました。
4. APIで何ができますか？
当社のAPIには、さまざまな活用方法があります。公開APIを使用して実行できる主な操作を以下にご紹介します：
a. コンタクト、タグ、カスタムフィールドの管理：
- コンタクト：新しいコンタクトの作成、既存のコンタクトの更新、高度なフィルターを使用したコンタクト一覧の表示、コンタクトの削除を行えます。
- タグの：タグの作成、コンタクトへの付与、一覧表示、削除を行えます。
- カスタムフィールド：利用可能なコンタクトのカスタムフィールドとその識別子（スラッグ）を取得し、コンタクト情報を正しく入力できます。
b. ニュースレターとキャンペーンの管理：
- ニュースレター：新しい下書きを作成したり、既存のニュースレターを部分的に更新したりできます。エディターの種類（クラシックまたはビジュアル）の指定、HTMLコンテンツ全体の取得、送信者情報の明示的な設定、IDを使用した特定のニュースレターの取得が可能です。
- キャンペーン：メールキャンペーン全体の作成、取得、更新、削除に加えて、個別のキャンペーンステップの作成、取得、更新、削除も可能です。
c. ファネルとページエディターの管理：
- ファネル：新しいファネルの作成、ファネルへの新しいステップ（ページ）の追加、特定のファネル内にあるすべての個別ステップの一覧取得を行えます。
- ページエディター：生成したページコンテンツをファネルステップまたはウェブサイトページに直接保存（全置換）したり、特定のページタイプのJSONスキーマを取得したりできます。
d. 料金プランとクーポンの管理：
- 作成、編集、削除：新しい料金プランやクーポンを作成したり、既存のものを部分的に更新または削除できます。
- 一覧表示と検索：既存のすべての料金プランとクーポンを一覧表示したり、IDを使用して特定の項目を取得できます。
e. コースと受講生の管理：
- コースと受講生：既存のコース一覧を取得し、現在登録されている受講生の一覧を取得できます。
- 受講生の登録：コンタクトを個別のコースにプログラムから登録できます。
コースに関する注意事項：コースバンドルへの対応は、今後のアップデートで追加される予定です。
f. コミュニティの管理：
- コミュニティ：既存のコミュニティ一覧を取得し、特定のコミュニティに現在参加しているメンバーの一覧にアクセスできます。
- メンバーを招待：コンタクトIDを指定して、新しいユーザーをコミュニティにプログラムから招待できます。
g. 自動化ルールの管理：
- 自動化ルール：一般的なイベントとアクションをプログラムから接続したり、既存のルールを更新したり（例：トリガーはそのままにしてアクションを変更）、ルールを論理削除できます。
- 一覧表示と取得：自動化ルールを一覧表示したり、IDを使用して特定のルールを取得できます。
h. サブスクリプションの管理：
- サブスクリプション：外部プラットフォームからサブスクリプション内のすべてのリソースの一覧を取得し、サブスクリプションを即時または請求期間の終了時に解約できます。
i. Webhookの管理
- リアルタイム通知を受信するための新しいWebhookをプログラムから作成したり、既存のWebhook一覧を取得したり、不要になったWebhookを削除できます。
j.デジタル商品の管理：
- デジタル商品：特定のデジタル商品の作成、更新、削除、取得を行えます。
- 料金プランのリンク：プログラム上で、デジタル商品に料金プランを直接作成またはリンクできます。
k.SMSテンプレートと予約カレンダーの管理：
- 一覧表示と取得：既存のSMSテンプレートと予約カレンダーイベントの一覧を取得したり、特定のものを検索できます。
注意事項：
- トークンを簡単に識別して管理できるようにするため、それぞれに固有の名前を付ける必要があります。
- トークンは作成直後にのみコピーできます。トークンをコピーし忘れた場合は、そのトークンを削除して新しいものを作成してください。
- セキュリティ対策として、systeme.ioアカウントで新しい公開APIキーが作成されるたびに、メールで通知します。
- 1つのアカウントにつき最大3つのAPIキーを作成できます。
詳細はこちら：APIドキュメント