Waafir
このページは機械翻訳であり、人による確認を待っています。誤りが含まれている可能性があります。

Platform API (/v1)

Platform API は、バージョン管理されたWaafirのHTTPインターフェースです。ご自身のシステムから組織の情報を読み取り、管理するために使用します。対象には、チーム(メンバーの招待、ロールの変更、削除)、データルーム・フォルダ・ファイルへのアクセス権の付与、Q&A、データルームのチャットとエージェント、アクティビティと相手方ごとのエンゲージメント、ポートフォリオモニタリングが含まれます。

これは、同じプラットフォームをAIクライアントにツールとして公開するWaafirのMCPサーバーとは別の窓口です。どちらも同じ個人アクセストークンで認証します。

ベースURL

すべてのエンドポイントは次の配下にあります。

https://app.waafir.io/api/v1

エンドポイントリファレンスには、各エンドポイントが GET /api/v1/team のようなフルパスで一覧表示されています。

最初の呼び出し

  1. トークンを発行する。 Waafirで アドオン → 設定 を開き、個人アクセストークンを発行します。始めるには read トークンで十分です。waafir_pat_ で始まる値をコピーしてください。値は一度しか表示されません。
  2. 自分が誰かを確認する。 GET /api/v1/session は、トークンが代理として動作する本人と組織を返します。トークンを使って開発を始める前に、トークンが機能することを確認するために使用してください。
curl -s https://app.waafir.io/api/v1/session \
  -H "Authorization: Bearer $WAAFIR_TOKEN"
{
  "orgId": "…",
  "userId": "…",
  "email": "you@example.com",
  "orgRole": "admin",
  "authMethod": "pat",
  "principalType": "user"
}

401 は、トークンが存在しない、入力ミスがある、期限切れ、または取り消されていることを意味します。その他の拒否には通常、機械可読な code が含まれており、エラーコードのページで説明しています。code を含まないものもあるため、必ずHTTPステータスにフォールバックしてください。

リファレンスの生成方法

エンドポイントとエラーコードのページは、このサイトが公開されるたびに、プラットフォーム自身のルートツリーから 生成 されます。手書きではありません。本番リリースではアプリと同じコミットからこれらが生成されるため、そのリリースが提供するルートが、各エンドポイントに必要なロールの制限とトークンのスコープ、受け付けるクエリパラメータとともに一覧表示されます。エラーの一覧は既知の最小限であり、網羅的ではありません。エンドポイントはジェネレーターが把握できないコードを返すことがあるため、一覧にないエラーはHTTPステータスで処理してください。

バージョニング

/v1 は、そのバージョン内では追加のみで変更されます。Waafirはレスポンスのフィールドや任意のリクエストパラメータを追加することがあります。/v1 の中で既存のフィールドを削除したり型を変更したり、エンドポイントを削除したりすることはありません。互換性を破る変更は、新しいバージョンのプレフィックスで提供されます。認識できないフィールドは無視するようにクライアントを作成してください。

次に読むもの