インタラクティブリファレンス
常に最新の完全なエンドポイントリファレンスは、ダッシュボード内のインタラクティブAPIエクスプローラーです。すべてのエンドポイント、パラメーター、レスポンススキーマをOpenAPI仕様で表示し、短期間有効なトークンを使ってアカウントに対してライブリクエストを実行することもできます。
ベースURL
Willet Cloudでは、すべてのエンドポイントは以下に存在します https://willet.bgenc.dev/api/v1. セルフホストサーバーは同じAPIを以下で提供します <your-server>/api/v1.
OpenAPI 3.1の生のスペックは以下で提供されます /api/v1/openapi.json クライアントを生成したり、独自のツールにインポートしたりする場合はこちら。
認証
すべてのリクエストにAPIシークレットをベアラートークンとして送信してください: Authorization: Bearer <secret>.
curl -H "Authorization: Bearer $WILLET_API_TOKEN" \
https://willet.bgenc.dev/api/v1/meWillet Cloudでは、ダッシュボードの設定 → APIシークレットからシークレットを発行できます。各シークレットにはスコープとアクセスレベルがあります:
user/projectすべてのプロジェクトを選ぶか、特定の1つだけを選びます。read/read_write読み取り専用、または読み取り/書き込みの両方を選びます。
エラー
エラーは2xx以外のステータスとJSONボディを返します: { "error": "message", "details": [...] }.
400 | リクエストの検証に失敗しました。 |
401 | シークレットが見つからないか、無効、失効、または期限切れです。 |
403 | シークレットに権限がありません(読み取り専用のシークレット、または許可されていない場所で使用されているプロジェクトスコープのシークレットなど)。 |
404 | リソースが存在しません。 |
501 | セルフホストサーバーでCloud専用エンドポイントが呼び出されました。 |
次へ
ターミナル派ですか?CLIを使えば、ログイン・JSON出力・終了コードを含めてこれらのエンドポイントをすべて操作できます。
CLIリファレンス →