API キーを使うと、開発者やあなたが運用するツールが Mateflow の Open API でコミュニティのデータを読み書きできます。API キーの作成と無効化は、管理画面 → 設定 → 連携 → API アクセスで行います。各キーは 1 つのコミュニティでのみ使えます。
対象者：オーナーと管理者。 · 場所：ウェブ（管理画面）。 · プラン：API アクセスと、コミュニティが 1 日に送れる API リクエスト数は、プラットフォームプランによって異なります。
API キーはコミュニティごとに作成する
API キーは 1 つのコミュニティに属し、キーを使ったリクエストは常にそのコミュニティに対して実行されます。複数のコミュニティを接続するには、それぞれのコミュニティの管理画面でキーを作成します。
クリエイターダッシュボード（app.mateflow.com）には API キーはありません。以前そこにあったワークスペース単位のキーは、コミュニティごとのキーに置き換えられました。クリエイターダッシュボードのコミュニティの概要ページには、そのコミュニティの連携ページへのリンクがあります。
API キーを作成する手順
- 管理画面 → 設定 → 連携に移動し、API アクセスタブを開きます。
- 新しいキーを生成をクリックします。
- 使うツールの名前など、用途がわかるキー名を入力します。
- スコープと権限で、連携に必要な権限だけにチェックを入れます。次のセクションを参照してください。
- 任意：IP ホワイトリスト（任意） に、キーの使用を許可する IP アドレスまたは範囲をカンマ区切りで入力します。
- 新しいキーを生成をクリックします。
- API キーが生成されましたからキーをコピーして安全な場所に保管し、完了をクリックします。
キー全体を確認できるのは一度だけです。紛失した場合は、新しいキーを生成し、古いキーを無効化してください。
API アクセスタブにアップグレードの案内が表示される場合は、プラットフォームプランに API アクセスが含まれていません。API エンドポイントカードには、リクエストのベース URL と、プランの 1 日あたりのリクエスト数の上限が表示されます。上限は 00:00 UTC にリセットされます。
API キーのスコープ（権限）
| スコープ | 許可される操作 |
|---|---|
| コミュニティの読み取り | コミュニティのプロフィール、設定、メタデータを読み取ります |
| コンテンツの読み取り | 投稿、フィード、返信、検索結果を読み取ります |
| コンテンツの書き込み | 投稿と返信を作成、編集、削除します |
| メディアのアップロード | アップロードトークンを要求します。署名付きメディア URL の読み取りも含みます |
| メディアの読み取り | 既存のメディアの署名付き URL を読み取ります |
| スペースの読み取り | スペースを一覧表示し、スペースの詳細を読み取ります |
| メンバーの読み取り | メンバーを検索し、アクセスグループを含む基本的なプロフィールを読み取ります |
| メンバーの招待 | メールアドレスまたは招待リンクで人を招待します |
メンバーの読み取りとメンバーの招待は、機微な権限の下に表示されます。メンバーの読み取りを使うと、連携はメールアドレスがコミュニティのメンバーのものかどうかを確認できます。メンバーの招待では、連携が別の招待者を指定しない限り、招待はコミュニティのオーナーとして送信されます。招待された人は、常にメンバーとして参加します。API による招待にはアクセスグループを含めることができます。アクセスグループの仕組みを参照してください。
キーのスコープは後から変更できません。古いキーにはすべて（旧仕様） と表示されることがあります。このキーには、作成時に存在していたスコープだけが付いています。新しいスコープを使うには、新しいキーを作成してください。
API キーを無効化する
- API アクセスタブの API キーで、対象のキーを見つけます。
- キーの操作メニューを開き、キーを無効化をクリックします。
- 確認します。無効化は元に戻せず、そのキーを使っているツールは動作しなくなります。
一覧には、各キーのステータス（有効、期限切れ、失効済み）と最終使用日が表示されます。API リクエストは配信ログに表示されないため、キーがまだ使われているかどうかは最終使用で確認します。Slack、Discord、Zapier の接続を切断しても、API キーは無効化されません。
API キーを安全に管理する
- API キーは、他の人がダウンロードできるウェブサイトやアプリではなく、サーバーに保管し、リクエストは HTTPS で送ってください。
- ツールごとに、必要なスコープだけを持つ個別のキーを用意します。そうすれば、1 つを無効化してもほかのツールに影響しません。
- ツールが固定のアドレスから呼び出す場合は、IP ホワイトリストを追加します。
- キーが漏洩した可能性がある場合は、すぐに無効化し、代わりのキーを作成してください。
API ドキュメントの場所
API リファレンスでは、エンドポイント、リクエストとレスポンスの形式、スコープ、エラーコード、コードサンプルを説明しています。API アクセスタブの開発者向けドキュメントカードにあるドキュメントを開くボタンから、mateflow.com/developers に移動できます。このリンクを開発者に送ってください。開発者はコミュニティのアカウントを持っている必要はなく、プランに API アクセスが含まれていなくてもこのページを利用できます。
関連記事
このガイドは役に立ちましたか？