メインコンテンツまでスキップ

ファイルダウンロード

生成済みのPDFファイルを取得するエンドポイントです。requestId を指定すると1リクエスト分をまとめてZIPで、requestId と fileId を指定すると個別のPDFとしてダウンロードできます。どちらも認証が必要で（appkey ヘッダー、または OAuth 2.0 のアクセストークン）、非同期生成の完了後やWebhook受信後の回収に使います。

ZIP一括ダウンロード​

エンドポイント情報​

  • URL: https://api.re-port-flow.com/v1/file/download/{requestId}
  • メソッド: GET
  • 認証: アプリケーションキー（appkey ヘッダー）が必要

レスポンス (200 OK)​

レスポンスボディ: ZIPファイル（バイナリ）

ヘッダー説明例
Content-Typeコンテンツタイプapplication/zip
Content-Lengthファイルサイズ（バイト）307200
Content-Dispositionファイル名attachment; filename="files.zip"

使用例​

cURL​

curl -X GET https://api.re-port-flow.com/v1/file/download/550e8400-e29b-41d4-a716-446655440000 \\
  -H "appkey: your-app-key" \\
  --output files.zip

JavaScript​

async function downloadZip(requestId) {
  const response = await axios.get(
    `https://api.re-port-flow.com/v1/file/download/${requestId}`,
    {
      headers: { 'appkey': process.env.APP_KEY },
      responseType: 'arraybuffer'
    }
  );

  fs.writeFileSync('files.zip', response.data);
  return response.data;
}

個別ファイルダウンロード​

エンドポイント情報​

  • URL: https://api.re-port-flow.com/v1/file/download/{requestId}/{fileId}
  • メソッド: GET
  • 認証: アプリケーションキー（appkey ヘッダー）が必要

レスポンス (200 OK)​

レスポンスボディ: PDFファイル（バイナリ）

ヘッダー説明例
Content-Typeコンテンツタイプapplication/pdf
Content-Lengthファイルサイズ（バイト）102400
Content-Dispositionファイル名attachment; filename="invoice.pdf"
File-IDファイルID7f3d1a2b-4c5e-6f7a-8b9c-0d1e2f3a4b5c

使用例​

cURL​

curl -X GET https://api.re-port-flow.com/v1/file/download/550e8400-e29b-41d4-a716-446655440000/7f3d1a2b-4c5e-6f7a-8b9c-0d1e2f3a4b5c \\
  -H "appkey: your-app-key" \\
  --output invoice.pdf

JavaScript​

async function downloadFile(requestId, fileId) {
  const response = await axios.get(
    `https://api.re-port-flow.com/v1/file/download/${requestId}/${fileId}`,
    {
      headers: { 'appkey': process.env.APP_KEY },
      responseType: 'arraybuffer'
    }
  );

  const returnedFileId = response.headers['file-id'];
  console.log('ダウンロードしたファイルID:', returnedFileId);

  return response.data;
}

エラーレスポンス​

404 Not Found​

{
  "statusCode": 404,
  "message": "File not found",
  "error": "Not Found"
}

原因:

  • 指定された requestId または fileId が存在しない
  • ファイルの有効期限が切れた

対処法:

  • requestId / fileId が正しいことを確認
  • ファイル生成から時間が経過している場合は再生成

ユースケース​

ZIP内の特定ファイルのみダウンロード​

// async/multiple のレスポンスから requestId と files を取得済みとする
async function downloadSpecificFile(requestId, files) {
  const targetFile = files.find(f => f.fileName === 'invoice_001.pdf');

  if (targetFile) {
    const pdfData = await downloadFile(requestId, targetFile.fileId);
    fs.writeFileSync('invoice_001.pdf', pdfData);
  }
}

よくある質問​

requestId と fileId、どちらでダウンロードすればよいですか​

リクエスト単位でまとめて取得したい場合は requestId のみでZIP一括ダウンロードを使います。生成した中の1ファイルだけが必要な場合は requestId と fileId の両方を指定して個別ファイルダウンロードを使ってください。

404エラーが返ってきた場合はどうすればよいですか​

requestId または fileId が誤っているか、ファイルの有効期限が切れている可能性があります。値を確認し、期限切れの場合は元のリクエストからPDFを再生成してください。

次のステップ​