認証

Reigniter APIはAPIキーを使用します。各キーは1つのアカウントに属し、そのアカウントとして機能します。つまり、そのアカウントのクレジットを使い、そのアカウントのジョブのみを確認します。

キーを作成する

API キーは Agency 計画の一部です。

1. サインインして Reigniter。
2. アカウント> APIキー(/app/account/api-keys)を開けてください。
3. 「 新しいキーを作成」で、後で認識できるラベル( CI pipeline や CMS sync)を入力してください。
4. 「 作成」を選択します。
5. すぐに鍵をコピーしろ。

鍵は一度だけ示されます

Reigniter キーのハッシュのみを保存します。完全なキーは作成時に一度表示されます。もし失くしたら取り消して新しく作成してください。

キーは次のような形で、 emp_ の後に64個の十六進数文字が続きます。

鍵を送れ

キーはすべてのリクエストでベアラートークンとして Authorization ヘッダーに入力します。

curl https://reigniter.ai/v1/me \
  -H "Authorization: Bearer $REIGNITER_API_KEY"

有効な鍵はアカウント 200 返します:

{
  "user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21",
  "email": "[email protected]",
  "name": "Sam",
  "credits_remaining": 42
}

鍵が拒否された場合

現状	code	意味
401	NO_API_KEY	Authorizationヘッダーがない場合、トークンがemp_で始まらない場合もあります。
401	INVALID_API_KEY	鍵は不明か、または取り消されています。
402	PLAN_UPGRADE_REQUIRED	キーは有効ですが、そのアカウントは Agency プランにはありません。
403	ACCOUNT_SUSPENDED	キーを所有しているアカウントは停止されます。

アカウントが Agency プランから抜けると、そのキーは再び上 Agencyになるまで機能しなくなります。

鍵は秘密にしておけ

• キーはシークレットマネージャや環境変数に保存します。必ずソース管理にコミットしないでください。
• APIは自分のサーバーからのみ呼び出してください。ウェブページやモバイルアプリでキーを送ってはいけません。そもそもAPIのCORSポリシーではブラウザからのリクエストは許可されていません。
• システムごとに1つの鍵を使い、明確なラベルを付けてください。そうすれば、他の鍵を壊さずに1つだけ取り消せます。
• APIキー画面には、各キーが最後に使用された時間が表示されます。見覚えのないキーや、使うべきでないキーは取り消すべきです。

鍵を取り消す

1. 口座> APIキーを開設。
2. アクティブキーのラベルでキーを探します。
3. Revokeキー(ビン)アイコンを選択してください。

取り消されたキーは、 401 INVALID_API_KEYで即座に拒否されます。取り消しは元に戻せません。すでにキーでレンダリングを始めていると、そのまま実行を続けます。