リファレンス · 認証

Photta API の認証 1 つのキー、1 つのヘッダー

要約

すべての Photta API 呼び出しで、キーを `Authorization: Bearer photta_live_xxx` として送信してください。キーはダッシュボードで作成され、エンドポイントごとのスコープは持たず、単一のクレジット残高を共有します。

  • 認証: Bearerキー
  • 制限: 600 リクエスト/分
  • 処理方式: 非同期、ポーリング

このページに記載されている数値はすべて以下に基づきます: Photta APIドキュメント · 確認済み

API の想定要件

認証の概要

ヘッダー
Authorization: Bearer photta_live_xxx
キーのプレフィックス
photta_live_
ベース URL
https://api.photta.app/api/v1
キーの作成場所
https://ai.photta.app
スコープ
1 つのキーですべてのエンドポイントにアクセスし、1 つのクレジット残高を共有

1 回の呼び出しでキーを確認

account エンドポイントは無料であるため、キーが動作することを確認するための安全な手段です。

curl https://api.photta.app/api/v1/account \
  -H "Authorization: Bearer $PHOTTA_API_KEY"

キーの取り扱い

  • 疑わしい場合はローテーションする

    ドキュメントには明記されています。漏洩が疑われるキーは直ちにローテーションしてください。まず代替キーを生成してデプロイし、その後に古いキーを無効化します。

  • サーバー側に保持する

    ブラウザに渡されたキーは、そのページを開いたすべてのユーザーに渡ることになります。バックエンドから API を呼び出し、結果をクライアントに渡してください。

  • 401 はリクエストではなくキーに原因があることを示す

    キーの欠落、無効、または期限切れは `authentication_error` を返します。他の場所を確認する前に、ヘッダーのタイポや不要な空白がないか確認してください。

  • すべてのキーの背後にある 1 つの残高

    キーは機能ごとにスコープ分けされていません。複数の環境向けに複数のキーを用意した場合でも、同じクレジット残高を消費します。残高は GET `/api/v1/account` で確認できます。

認証に関する質問

リクエストの認証方法を教えてください。

すべての呼び出しで、AuthorizationヘッダーにBearerトークンとしてキーを送信します。個別のログインやトークン交換ステップはありません。

キーはどこで作成できますか?

Phottaダッシュボードで作成します。再発行も同じ場所で行われます。これは401エラーが発生した際にドキュメントが案内する場所でもあります。

ブラウザからAPIを呼び出せますか?

ご自身のキーを直接使用して呼び出すことはできません。ブラウザに送信されたものは訪問者に読み取られる可能性があるため、独自のサーバーの背後に呼び出しを配置し、その結果を転送してください。

キーが漏洩した場合はどうすればよいですか?

直ちにローテーションしてください — 新しいキーを生成してデプロイし、その後に古いキーを削除します。すでに消費されたcreditsは回収できないため、まずはローテーションを行い、その後に調査してください。

エンドポイントとリファレンス

このページに記載されている数値はすべて以下に基づきます: Photta APIドキュメント · 確認済み

5分でAPIを試す

Photta APIキーを生成し、上記のcURLスニペットを貼り付ければ、コーヒーが淹れ終わる前に最初のモデル着用画像が手に入ります。

  • Bearerキー
  • 600 リクエスト/分
  • 非同期、ポーリング