リクエストを認証する

Bannerify API へのリクエストには、必ず API キーを付けます。キーは 1 つのワークスペースに属します。キーはそのワークスペースのテンプレートをレンダリングし、生成の回数はキーに数えられます。

API キーを作成する

ダッシュボードで API Keys ページを開きます。
New API key をクリックします。
名前を入力して Create をクリックします。
該当する行の Copy key ボタンで、キーをコピーします。

キーは、64 文字の英数字の文字列です。プロジェクトやワークフローごとにキーを 1 つ作っておくと、ほかのキーに影響を与えずに、1 つだけを入れ替えられます。

キーを送る

キーの送り方は、エンドポイントによって異なります。

エンドポイント	キーを置く場所
`createImage`、`createStoredImage`、`createPdf`、`createStoredPdf`	JSON ボディの `apiKey`
`info`、`templates`、`templates/:id`	クエリパラメーターの `apiKey`
`signedurl`	どこにも置きません。URL が `apiKeyHashed` と `sign` を持っています。署名付き URLを参照してください

API は、ボディまたはクエリからキーを読み取ります。Authorization ヘッダーは無視します。

curl --request POST \
  --url https://api.bannerify.co/v1/templates/createImage \
  --header 'Content-Type: application/json' \
  --data '{
    "apiKey": "YOUR_API_KEY",
    "templateId": "tpl_xxx"
  }'

未知のキーは、メッセージ Invalid api key の BAD_REQUEST で失敗します。

キーを安全に保つ

キーを持っている人は誰でも、あなたのクォータを消費してファイルを生成できます。キーはサーバー側で管理してください。

キーは、環境変数またはシークレットマネージャーに保存します。
git にコミットしないでください。ブラウザのコードやモバイルアプリにも入れないでください。
生成した画像をブラウザに表示するには、サーバーで署名付き URLを作ります。署名付き URL が持つのはキーではなく、署名です。

キーを入れ替える

キーが漏えいした場合や、不要になった場合は、次の手順で入れ替えます。

新しいキーを作成します。
サーバーとワークフローを、新しいキーを使うように更新します。
古いキーを削除します。API Keys ページで、その行の Delete key をクリックします。

削除したキーは、少し時間をおいて使えなくなります。そのキーで署名した署名付き URL も同様です。