ReWords.AI API

認証

ReWords.AI の API キーをウェブサイトで作成し、Bearer トークンとして送信します。キーと Webhook シークレットは安全に保管してください。

キーを取得する

  1. 請求先にしたいアカウントで rewords.ai にサインインします。
  2. API パック(編集パックまたは OCR パック)を購入します。API の残高はウェブサイトのクレジットとは別です。 ウェブサイトのクレジットは API に使えず、API パックを買ってもウェブサイトのクレジットは増えません。
  3. API キーのページを開いてキーを作成します。キーはアカウントに API 残高があるときに作成できます。

1 つのアカウントで同時に持てるキーは最大 5 つです(たとえば環境ごとに 1 つ)。取り消したキーは数に入りません。 購入前に仕上がりを確認したい場合は、ウェブサイトで画像を 1 枚無料で編集できます。

キーを使う

すべてのリクエストで、Authorization ヘッダーに API キーを入れてください:

Authorization: Bearer rw_live_your_key
  • キーがない、存在しない、または取り消されている場合は 401 invalid_api_key が返ります。
  • 完全なキーは作成時に一度だけ表示されます。シークレット管理サービスに保存し、フロントエンドのコードやアプリのバンドルには絶対に入れないでください。
  • API キーのページでは、どのキーも名前の変更や取り消しができます。取り消したキーは 1 分以内に使えなくなります。
  • アカウントのすべてのキーは、同じ残高と同じレート制限を共有します。
  • 残高がなくなってもキーは有効なままで、別のパックを購入するまでリクエストは 402 を返します。
  • スキームは大文字と小文字を区別しません。Bearer でも bearer でも動きます。

Webhook シークレット

アカウントには Webhook シークレット(whsec_...)も 1 つあり、同じ API キーのページに表示されます。これは お送りする Webhook の署名に使われます。API キーと同じようにサーバー上で保管し、漏れた場合は API キーのページで リセットして受信側を更新してください。

このページの内容