API リファレンス

Bannerify API は、テンプレートと値の組を、画像または PDF に変えます。テンプレート ID と変更したい値を送ると、レスポンスがそのままファイルになります。ホスト済みの URL の取得、署名付き画像 URL の作成、テンプレートの一覧取得もできます。

ベース URL

https://api.bannerify.co

すべてのエンドポイントは /v1 の下にあります。

エンドポイント

メソッド	パス	用途
POST	/v1/templates/createImage	画像を取得する
POST	/v1/templates/createStoredImage	ホスト済みの画像 URL を取得する
POST	/v1/templates/createPdf	PDF を取得する
POST	/v1/templates/createStoredPdf	ホスト済みの PDF URL を取得する
GET	/v1/templates/signedurl	署名付き URL から画像をレンダリングする
GET	/v1/templates	テンプレートを一覧表示する
GET	/v1/templates/:id	レイヤーを含むテンプレート 1 件を取得する
GET	/v1/info	キーがどのワークスペースに属するかを確認する

最初のリクエストを送る

API キーとテンプレート ID が必要です。

curl --request POST \
  --url https://api.bannerify.co/v1/templates/createImage \
  --header 'Content-Type: application/json' \
  --output banner.png \
  --data '{
    "apiKey": "YOUR_API_KEY",
    "templateId": "tpl_xxx",
    "modifications": [
      { "name": "headline", "text": "Hello from the API" }
    ]
  }'

レスポンスのボディが画像で、banner.png にその画像が保存されます。オプションについては、画像の生成で説明しています。

リクエストとレスポンスの仕組み

• POST エンドポイントは JSON ボディを受け取ります。ボディと一緒に Content-Type: application/json ヘッダーを送ってください。
• GET エンドポイントはクエリパラメーターを受け取ります。
• レンダリング用のエンドポイントは、レンダリングの完了を待って、同じレスポンスでファイルを返します。保存用のエンドポイントは、ファイルの url を含む JSON を返します。
• 失敗したリクエストは、JSON の error オブジェクトを返します。コードの一覧はエラーを処理するにあります。
• すべてのレスポンスに X-Request-Id ヘッダーが付きます。リクエストについてサポートに問い合わせるときは、この値を伝えてください。
• API は Access-Control-Allow-Origin: * を返しますが、API キーはリクエストに含まれて送られるため、ブラウザではなくサーバーから API を呼び出してください。ブラウザに画像を表示するには、署名付き URLを使います。

上限

各 API キーは、レンダリング用エンドポイントのグループに、10 秒間に 100 回までリクエストを送れます。また、各ワークスペースには、1 日または 1 か月の生成上限があります。詳しくはクォータと上限をご覧ください。

SDK

公式の SDK (JavaScript、Python、PHP、Go) が、これらのリクエストを代わりに送ります。