開始使用
重要概念
了解 Bannerify 用來稱呼專案、範本、圖層、modification 和生成的名詞。
你只需要設計一次範本。範本上的每個元素都是圖層,每個圖層都有名稱。要產生圖片時,你會傳送範本 ID,以及一份 modification 清單,用圖層名稱為其中一些圖層設定新的值。Bannerify 會用你的值繪製範本,回傳圖片或 PDF,並從你的用量額度中扣除一次生成。
專案
專案擁有範本、上傳的素材、API 金鑰、方案和生成次數。儀表板稱為專案,API 參考則稱為工作區。每個帳號都有一個 Personal 專案,你也可以建立團隊專案。管理專案與成員說明了做法。
範本
範本是畫布上的一份設計。你可以在範本編輯器中製作,也可以從圖庫挑選範本開始。範本可以繪製成 PNG、JPEG 或 WebP 圖片,或是 PDF。
範本 ID
範本 ID 會告訴 API 要繪製哪一個範本,格式像 tpl_xxx。開啟範本卡片上的選單,點選 Copy Template ID 即可複製。
畫布
畫布是範本的繪圖區域。它的寬度和高度,就是圖片的大小或 PDF 頁面的大小,單位為像素。請求無法變更畫布大小。
圖層
圖層是畫布上的一個元素,例如文字、圖片、QR 碼、條碼或表格。如果想從 API 變更某個圖層,請先為它命名。圖層類型列出了你可以新增的圖層。
Modification
modification 會為一個圖層設定新的值。它有一個選擇圖層的 name,以及用來變更圖層的欄位,例如 text、src 或 color。請求會帶有一份 modification 清單,沒有列入清單的圖層會維持範本中的值。Modifications列出了所有欄位。
生成
生成是指把範本繪製成一個檔案。每次成功繪製都會計入你的用量額度,但有少數例外,用量額度與限制列出了這些例外。若要查看過去的繪製紀錄,請開啟側邊欄的 Generations,或是開啟範本卡片上的選單,點選 View generations。每一列都會顯示時間、範本、格式、大小,以及這次繪製是否計費,你也可以複製請求所傳送的 modification。更多說明請見查看你的生成紀錄。
直接、儲存與簽署
你可以用三種方式取得生成的檔案。
| 方式 | 端點 | 你會取得 |
|---|---|---|
| 直接 | createImage, createPdf |
回應本文中的檔案 |
| 儲存 | createStoredImage, createStoredPdf |
含有託管檔案 url 的 JSON |
| 簽署網址 | signedurl |
可放進 <img> 標籤的圖片網址。網址帶有簽章,而不是你的金鑰 |
API 金鑰
API 金鑰是屬於單一專案的 64 字元密鑰。請在儀表板的 API Keys 頁面建立。驗證請求說明了該把金鑰傳送到哪裡。
用量額度與速率限制
用量額度是方案每個月允許的生成次數,Free 方案則還會限制每天的次數。速率限制是單一 API 金鑰在 10 秒內可以傳送的請求數。兩者都在用量額度與限制中說明。