Python SDK

bannerify は、Python 3.8 以降向けの Bannerify クライアントです。エラーを値として返すため、リクエストが失敗しても例外は発生しません。

インストール

pip install bannerify

uv add bannerify

クライアントを作成する

API キーが必要です。ダッシュボードの API Keys ページで作成し、サーバー側で管理してください。

import os

from bannerify import BannerifyClient

client = BannerifyClient(os.environ["BANNERIFY_API_KEY"])

クライアントは HTTP のコネクションプールを保持します。終わったら client.close() を呼ぶか、クライアントをコンテキストマネージャーとして使ってください。

with BannerifyClient(os.environ["BANNERIFY_API_KEY"]) as client:
    result = client.create_image("tpl_xxx")

画像を生成する

result = client.create_image(
    "tpl_xxx",
    modifications=[{"name": "headline", "text": "Summer sale"}],
)

if "error" in result:
    raise RuntimeError(result["error"]["message"])

with open("banner.png", "wb") as file:
    file.write(result["result"])

result["result"] に、画像のバイト列が入っています。

メソッド

最初の 3 つは画像と PDF の作成で、動画のメソッドは動画のレンダリングで、最後の 1 つは署名付き URLで説明しています。

エラーを処理する

generate_image_signed_url 以外のメソッドは、result キーまたは error キーのどちらかを持つ dict を返します。両方を持つことはありません。

{"result": b"..."}

{"error": {"code": "NOT_FOUND", "message": "...", "docs": "...", "requestId": "..."}}

API が返すエラーには、4 つのキーがすべてあります。docs は、そのコードのページへのリンクです。リクエストについてサポートに問い合わせるときは、requestId を伝えてください。コードの一覧は、エラーにあります。

SDK は、いくつかのエラーを自分で作ります。これらには code、message、docs はありますが、requestId はありません。

generate_image_signed_url は文字列を返し、形式がサポートされていない場合は ValueError を発生させます。

オプション

client = BannerifyClient(
    os.environ["BANNERIFY_API_KEY"],
    timeout=30.0,
)

Modification モデル

modification は dict です。bannerify の Modification モデルを渡すこともでき、クライアントが変換します。

from bannerify import Modification

client.create_image("tpl_xxx", modifications=[Modification(name="headline", text="Hello")])