API 參考

Bannerify API 會把範本和一組值變成圖片或 PDF。你傳送範本 ID 和要變更的值，回應就是檔案。你也可以要求託管的網址、建立簽署圖片網址，以及列出你的範本。

基本網址

https://api.bannerify.co

所有端點都位於 /v1 之下。

端點

方法	路徑	用途
POST	/v1/templates/createImage	取得圖片
POST	/v1/templates/createStoredImage	取得託管的圖片網址
POST	/v1/templates/createPdf	取得 PDF
POST	/v1/templates/createStoredPdf	取得託管的 PDF 網址
GET	/v1/templates/signedurl	從簽署網址渲染圖片
GET	/v1/templates	列出你的範本
GET	/v1/templates/:id	取得單一範本及其圖層
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，而不要從瀏覽器呼叫。要在瀏覽器中顯示圖片，請使用簽署網址。

上限

每個 API 金鑰在 10 秒內，最多可以向一組渲染端點傳送 100 個請求，而每個工作區都有每日或每月的生成上限。詳情請見配額與上限。

SDK

官方 SDK 包含 JavaScript、Python、PHP 和 Go，它們會代你傳送這些請求。