SDK
SDK
Bannerify の SDK で、JavaScript、PHP、Go、Python から画像と PDF を生成します。
SDK は REST API をラップしています。API キーの送信、リクエスト前の画像形式の確認、エラーを値として返す処理、署名付き URL の作成を、代わりに行います。HTTP リクエストを送れる言語なら、どれでも API を直接呼び出せます。
JavaScript SDK
JavaScript と TypeScript からファイルを生成します
PHP SDK
PHP アプリケーションからファイルを生成します
Go SDK
Go のサービスやワーカーからファイルを生成します
Python SDK
Python のスクリプトやアプリからファイルを生成します
各 SDK の対応状況
| JavaScript | Python | PHP | Go | |
|---|---|---|---|---|
| 画像を作成する | あり | あり | あり | あり |
| PDF を作成する | あり | あり | あり | あり |
| 保存済み画像を作成する | あり | あり | あり | なし |
| 署名付き URL を生成する | あり | あり | あり | あり |
| 自分の S3 バケットに保存する | あり | なし | なし | なし |
createStoredPdf、テンプレートのエンドポイント、info エンドポイントをラップする SDK はありません。これらは REST で呼び出してください。
エディターを埋め込む
@bannerify/embed と @bannerify/embed-react は、ブラウザ向けのパッケージです。Bannerify のエディターをアプリに組み込むもので、REST API は呼び出しません。使い方は、アプリにエディターを埋め込むで説明しています。
サーバー側で SDK を使う
どの SDK も、クライアントの作成時に API キーを受け取ります。そのため、サーバーのコード、ワーカー、スクリプトで実行してください。ブラウザに渡してよいのは署名付き URL だけです。署名付き URL が持つのは、API キーではなく署名だからです。使い方は、署名付き URLで説明しています。