ベースアドレス

ベースアドレス

すべてのエンドポイントは、このプレフィックスの配下にあります。ローカルインストールでは、既定のアドレスは以下の値です。

https://api.pdfgine.com/api/v1

一覧取得エンドポイントのページ分割

ページ分割に対応する一覧取得エンドポイントは5つあります。テンプレートの/history、/assets、/marketplace/templates、/templates、/componentsです。それぞれ任意のlimit（1-200）とbeforeを受け付けます。レスポンスは引き続き通常の配列のため、既存の読み取り処理を変更する必要はありません。

limitを指定しない場合は最大200行が返され、続きがある場合はrel="next"付きのLinkヘッダーが含まれます。次のURLを自分で構築せず、このリンクを使用してください。カーソルは履歴ではバージョン番号、アセットではアセットID、それ以外では不透明な値であり、どれを使うかはヘッダーが把握しています。/marketplace/templatesのカーソルはフィルターも含むため、検索、カテゴリー、localeを変更すると使えなくなります。同じカーソルが別の一覧を指さないようにするための、意図した動作です。ほかの一覧取得エンドポイントは、もともと件数が制限されたコレクションを返します。途中までのレスポンスにはX-PDFgine-List-Truncated: trueとX-PDFgine-List-Limitも含まれ、最終ページにはどちらも含まれません。

機械可読な仕様書

これらのページの内容は、OpenAPI 3.0文書としても公開されています。クライアント生成ツール、Postman、エディターに指定すると、パス、リクエスト本文、ペイロードの例を手作業でコピーすることなく取得できます。

https://api.pdfgine.com/openapi/v1.json

この文書は実行中のAPIから生成されるため、誰かが記録したバージョンではなく、実際に呼び出しているバージョンを示します。