製品・APIガイド

プレビューリンク

ビューアーと埋め込みの設定

アカウントの埋め込みビューアー設定で、外観、タイトルの表示、ページ移動を設定します。ブランド表示の削除と埋め込みはプランの権利によって異なります。パネルに表示される利用可否を確認してください。

許可サイト

ビューアーを埋め込むサイトを許可サイトに追加してください。埋め込み権限と共有の有効性は別々に確認されます。サイトを許可しても、期限切れや取り消し済みの共有は再有効化されません。ブラウザーのコードやiframeのURLにAPIキーを含めないでください。

共有前の確認

受信者と同じ条件でリンクをテストしてください。ページ数、グラフや表のレイアウト、ダウンロード可能な形式、有効期限を確認します。許可されていないサイトでの埋め込みもテストしてください。アカウント内のプレビューが動作するだけでは、外部アクセスが有効であることは確認できません。

アカウントなしで顧客が開ける、有効期限付きの閲覧リンクを作成します。1回の呼び出しで、PDFとDOCXのダウンロードリンクを両方返すことができます。

リクエスト 
curl -X POST https://api.pdfgine.com/api/v1/preview \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "templateCode": "invoice", "formats": ["pdf", "docx"], "data": { } }'
レスポンス 
{
  "previewId": "prv_481fac83d9f14a4493021eb128d0876b",
  "previewUrl": "/p/prv_481fac83d9f14a4493021eb128d0876b",
  "expiresAt": "2026-08-29T13:23:43+00:00",
  "pageCount": 1,
  "downloads": [
    { "format": "pdf", "downloadUrl": "/api/v1/previews/prv_481f.../download/pdf?expires=...&token=..." },
    { "format": "docx", "downloadUrl": "/api/v1/previews/prv_481f.../download/docx?expires=...&token=..." }
  ]
}

リンクには推測できない署名が含まれ、expiresAtに終了します。

ドキュメントの利用可能期間

PDFgineはドキュメントを生成・配信します。生成したドキュメントを保存するかは、お客様が選択します。本製品が保持するのは、自身の入力（テンプレート、ブランドアセット）と一時的な出力のみです。各出力は、リクエストで選択した期間保持されます。accessProfile: shortは24時間（既定）、standardは7日、extendedは30日（7日と30日はGo以上）、quarterは90日（Max）です。その期間中、共有リンクは開いたままとなり、本番ドキュメント（/render、/documents/render）はAPIで再ダウンロードできます。期間終了後、ダウンロードは410を返し、出力は24時間以内に削除されます。生成記録、ページ数、使用量データは残ります。永続的に保存するには、生成後すぐに自分のシステムへ保存してください。

90日間有効なリンク

standardとextendedのプロファイルに加え、リンクを90日間保持するquarterプロファイルがあります。相手が四半期全体にわたって開き直す必要のある契約などに利用できます。最上位プランで提供され、各プランで利用できるプロファイルは、そのプランの権限に表示されます。

リンクを早期に終了する

共有リンクは通常expiresAtで終了します。それ以前に閲覧を止める場合は取り消してください。204が返され、リンクは直ちに利用できなくなります。

cURL 
curl -i -X POST https://api.pdfgine.com/api/v1/previews/prv_481fac83d9f14a4493021eb128d0876b/revoke \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

HTTP/1.1 204 No Content

よくある問題

  • プレビュー作成は200ではなく201、取り消しは本文なしの204を返します。すべてのレスポンスをJSONとして解析するクライアントでは、取り消し時に失敗します。
  • accessProfileでリンクの有効期間を決めます。長い期間のプロファイルには対象プランが必要です。quarterを含まないプランで指定すると、黙って短縮されるのではなく拒否されます。
  • downloads内のダウンロードリンクには、署名と有効期限があります。これらのアドレスではなくpreviewIdを保存してください。保存したアドレスは、期限が切れると使えなくなります。
  • 取り消しはリンクを無効にするもので、ドキュメントは削除しません。ファイルは引き続きご自身のもので、保存期間が終了するまでAPI経由でダウンロードできます。
  • プレビューは本番生成の利用枠ではなく、プレビューページ数を消費します。同じドキュメントを/renderで再生成すると、別の課金対象ページ数として集計されます。