JavaScript SDK

bannerify-js 是 JavaScript 和 TypeScript 的 Bannerify 用戶端。每個選項都有型別，並以值的形式回傳錯誤，所以請求失敗時不會擲出例外。

安裝

npm install bannerify-js

pnpm add bannerify-js

yarn add bannerify-js

bun add bannerify-js

建立用戶端

你需要一組 API 金鑰。請到儀表板的 API Keys 頁面建立，並把它留在伺服器上。

import { Bannerify } from "bannerify-js"

const bannerify = new Bannerify(process.env.BANNERIFY_API_KEY!)

createClient(apiKey) 會回傳同一個用戶端。

生成圖片

import { writeFile } from "node:fs/promises"

const { result, error } = await bannerify.createImage("tpl_xxx", {
  modifications: [{ name: "headline", text: "Summer sale" }],
})

if (error) throw new Error(error.message)

await writeFile("banner.png", Buffer.from(result))

result 是存放圖片位元組的 ArrayBuffer。

方法

前三個方法請見建立圖片和 PDF，影片方法請見渲染影片，最後一個請見簽署網址。

處理錯誤

除了 generateImageSignedUrl 之外，每個方法都會回傳含有 result 或 error 的物件。檢查 error 之後，TypeScript 會縮小型別。

const { result, error } = await bannerify.createImage("tpl_xxx")

if (error) throw new Error(`${error.code}: ${error.message}`)

console.log(result.byteLength)

error 有四個欄位：code、message、docs 和 requestId。docs 連結到該代碼的頁面。需要針對某個請求尋求協助時，請把 requestId 提供給支援團隊。

SDK 自己新增了兩個代碼。INVALID_FORMAT 表示圖片格式不是 png、jpeg 或 webp。TIMEOUT_ERROR 表示請求超過逾時時間。不是來自 API 的失敗，例如連線中斷，則會擲出例外。

generateImageSignedUrl 會回傳字串，當格式不受支援時會擲出例外。

選項

const bannerify = new Bannerify(process.env.BANNERIFY_API_KEY!, {
  timeout: 30_000,
})