製品・APIガイド

マーケットプレイスのテンプレート

完成済みデザインが提供するもの

マーケットプレイスでは、提案書、レポート、プレゼンテーションなどのドキュメント向けに、PDFgineがデザインしたひな型を提供します。ワークスペースに追加後、ジェネレーターでテキスト、データ、色、レイアウトを編集できます。

現在、マーケットプレイスでテンプレートを公開しているのはPDFgineのみです。顧客が独自のテンプレートを販売する仕組みはありません。

利用方法

無料：必要な権限を持つユーザーは、テンプレートを直接ワークスペースに追加できます。
プランに含まれる場合：有効なサブスクリプションのプランにテンプレートが含まれていれば、追加料金はかかりません。
有料：一回払いの支払い確認後、対象のワークスペースにテンプレートをインストールできます。

テンプレートの入手と利用

カテゴリや検索でデザインを探し、表紙と説明を確認してください。
無料またはプランに含まれるテンプレートを追加するか、有料デザインの安全な決済を完了してください。
インストールすると、選択したワークスペースのテンプレートに、編集可能なデザインのコピーが追加されます。
ジェネレーターで開き、サンプルデータを自分のデータに置き換え、公開前にPDF、Word、Viewerの出力を確認してください。

テンプレートコードは、ワークスペース内で一意でなければなりません。重複しても既存のテンプレートは上書きされず、別のコードの選択を求められます。

API経由での公開とインストール

マーケットプレイス画面のすべての操作を、エンドポイントから行えます。公開済みの商品一覧の取得、アカウントへのテンプレートのコピー、ご自身のテンプレートの公開、価格の設定が可能です。

cURL

# 公開済みの項目を一覧表示
curl -s "https://api.pdfgine.com/api/v1/marketplace/templates?locale=en" \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

# 1つを自分のアカウントにコピー
curl -X POST https://api.pdfgine.com/api/v1/marketplace/templates/consulting-proposal/install \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "code": "proposal", "name": "提案書" }'

# 自分のテンプレートを公開
curl -X POST https://api.pdfgine.com/api/v1/templates/invoice/marketplace \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "title": "支払い条件付きの請求書",
        "summary": "支払い条件と合計ブロックを含む請求用テンプレート。",
        "category": "reports",
        "locale": "en",
        "license": "commercial",
        "visibility": "public",
        "confirmAssetRedistributionRights": true
      }'

# 価格を設定 - isFreeがfalseの場合、priceMinorUnitsは必須
curl -X PUT https://api.pdfgine.com/api/v1/marketplace/templates/invoice-with-payment-terms/offer \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "isFree": false,
        "priceMinorUnits": 4900,
        "currency": "USD",
        "includedPlanCodes": ["business", "enterprise"],
        "expectedVersion": 3
      }'

インストールすると、テンプレートがご自身のアカウントにコピーされます。発行者によるその後の変更は、コピーには反映されません。公開時には、テンプレートに含まれるフォントと画像を再配布する権利があることの確認が求められ、その確認内容が記録されます。

独自のグラフとテンプレート

独自のテンプレートやグラフを作成するために、マーケットプレイスで購入する必要はありません。販売しているのは、PDFgineが用意した完成済みのデザインです。

マーケットプレイスを開く →

よくある問題

インストールすると、デザインがワークスペースにコピーされます。発行者による後の変更はコピーに反映されず、ご自身の編集内容も上書きされません。
コードは、ワークスペース内で未使用である必要があります。重複してもテンプレートは上書きされません。インストールが拒否され、別のコードの指定を求められます。
現在、公開できるのはPDFgineのみです。publisherロールのないワークスペースでは、公開・販売条件のエンドポイントは403を返すため、これらを使った販売者向けフローはまだ作成しないでください。
一覧のカーソルにはフィルターが含まれます。beforeを保持したまま検索、カテゴリー、localeを変更すると、意図的に400が返されます。同じカーソルが別の一覧を指さないようにするためです。
有料デザインは、支払いが確認された後にのみインストールできます。先にインストールを呼び出し、後から決済すると、キュー待ちではなく拒否されます。