驗證請求

每個傳送到 Bannerify API 的請求都要帶有 API 金鑰。金鑰屬於一個工作區，它會渲染該工作區的範本，生成次數也會計入該工作區。

建立 API 金鑰

1. 在儀表板中開啟 API Keys 頁面。
2. 點選 New API key。
3. 輸入名稱，然後點選 Create。
4. 使用該列的 Copy key 按鈕複製金鑰。

金鑰是由 64 個字母和數字組成的字串。為每個專案或工作流程各建立一個金鑰，這樣更換其中一個時，就不會影響其他金鑰。

傳送金鑰

傳送金鑰的方式依端點而定。

端點	金鑰放在哪裡
createImage、createStoredImage、createPdf、createStoredPdf	JSON 內文中的 apiKey
info、templates、templates/:id	查詢參數 apiKey
signedurl	不需要放。網址已帶有 apiKeyHashed 和 sign。請見簽署網址

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"
  }'

未知的金鑰會以 BAD_REQUEST 失敗，訊息為 Invalid api key。

妥善保管金鑰

任何拿到你金鑰的人，都能生成並消耗你的配額，所以請把金鑰留在伺服器上。

• 把金鑰存放在環境變數或密鑰管理工具中。
• 不要把它提交到 git，也不要放進瀏覽器端的程式碼或行動應用程式。
• 如果要在瀏覽器中顯示生成的圖片，請在伺服器上建立簽署網址。它帶的是簽章，而不是金鑰。

更換金鑰

如果金鑰外洩，或你不再需要它：

1. 建立新金鑰。
2. 更新你的伺服器和工作流程，改用新金鑰。
3. 刪除舊金鑰。在 API Keys 頁面中，點選該列的 Delete key。

已刪除的金鑰會在短暫延遲後失效，它所簽署的簽署網址也一樣。