はじめに
重要な概念
Bannerify で使うプロジェクト、テンプレート、レイヤー、modification、生成といった用語を説明します。
テンプレートは一度デザインします。テンプレート上のすべての要素はレイヤーで、どのレイヤーにも名前があります。画像を作るには、テンプレート ID と、レイヤー名を指定して新しい値を設定する modification のリストを送ります。Bannerify はあなたの値でテンプレートを描画し、画像または PDF を返して、クォータを 1 生成分消費します。
プロジェクト
プロジェクトは、テンプレート、アップロードしたアセット、API キー、プラン、生成回数をまとめて持ちます。ダッシュボードではプロジェクト、API リファレンスではワークスペースと呼びます。どのアカウントにも Personal プロジェクトがあり、チーム用のプロジェクトを作成することもできます。やり方はプロジェクトとメンバーの管理で説明しています。
テンプレート
テンプレートは、キャンバス上のデザインです。テンプレートエディターで作るか、ギャラリーのテンプレートから始めます。テンプレートは、PNG、JPEG、WebP の画像、または PDF として描画されます。
テンプレート ID
テンプレート ID は、API にどのテンプレートを描画するかを伝えます。tpl_xxx のような形式です。テンプレートカードのメニューを開き、Copy Template ID をクリックすると取得できます。
キャンバス
キャンバスは、テンプレートの描画領域です。幅と高さが、画像または PDF のページのサイズ（ピクセル単位）になります。リクエストでキャンバスのサイズは変更できません。
レイヤー
レイヤーは、キャンバス上の 1 つの要素です。テキスト、画像、QR コード、バーコード、表などがあります。API から変更したいレイヤーには、名前を付けてください。追加できる種類は、レイヤーの種類にまとめています。
Modification
modification は、1 つのレイヤーに新しい値を設定します。レイヤーを選ぶ name と、レイヤーを変更する text、src、color などのフィールドで構成されます。リクエストには modification のリストを入れます。リストに含めなかったレイヤーは、テンプレートの値のままです。すべてのフィールドはModificationsで確認できます。
生成
生成とは、テンプレートを 1 つのファイルに描画することです。描画が成功するたびにクォータを消費しますが、例外がいくつかあります。例外はクォータと制限にまとめています。過去の描画を確認するには、サイドバーの Generations を開くか、テンプレートカードのメニューから View generations をクリックします。各行には、時刻、テンプレート、形式、サイズ、課金対象かどうかが表示され、リクエストで送った modification をコピーできます。詳しくは生成履歴の確認を参照してください。
直接取得、保存、署名付き URL
生成したファイルは、3 通りの方法で取得できます。
| 方法 | エンドポイント | 取得できるもの |
|---|---|---|
| 直接取得 | createImage, createPdf |
レスポンスボディに入ったファイル |
| 保存 | createStoredImage, createStoredPdf |
ホスト済みファイルの url を含む JSON |
| 署名付き URL | signedurl |
<img> タグに置ける画像 URL。URL にはキーではなく署名が含まれます |
それぞれの使い方は、画像の生成、PDF の生成、署名付き URLで説明しています。
API キー
API キーは、1 つのプロジェクトに属する 64 文字のシークレットです。ダッシュボードの API Keys ページで作成します。キーの送り先はリクエストの認証で説明しています。
クォータとレート制限
クォータは、プランで許可される 1 か月あたりの生成回数です。Free プランでは 1 日あたりの回数にも上限があります。レート制限は、1 つの API キーが 10 秒間に送信できるリクエスト数です。どちらもクォータと制限で説明しています。