ドキュメント
DocRelay の概要
DocRelay は、
提供状況
- 提供開始に
向けて 準備中です。 - 管理画面
（app.docrelay.jp） から 事前登録できます。 事前登録いただいた 方には、 提供開始時に お知らせします。 - プランと
料金は料金表に 掲載しています （Free プランあり。 月額・税別）。 - ご相談はお問い合わせから
承ります。
利用の流れ
- 管理画面で
テンプレートを 作成します。 テンプレートエディターで テキスト・線・矩形・画像・明細テーブル・本文を 配置するか、 差し込み項目を 記述した Excel・Word ファイルを アップロードします。 - サンプルデータで
プレビューし、 テスト環境の API キーで 発行を 確認します。 - テンプレートの
バージョンを 公開します。 本番環境の API キーは、 公開中の バージョンで 発行します。 POST /v1/rendersに、テンプレート名・出力形式・ データを 指定して 送信します。 wait秒以内に完了すれば、 帳票を その 場で 返却します。 完了しない 場合は 202でID を 返し、 完了時に Webhook （ render.succeeded）で 通知します。 - 発行した
帳票は、 有効期限 付き URL で 共有するか、 API で 取得します。 保存期間を 過ぎた 帳票は 削除し、 改ざん検知ログだけを 残します。
テンプレートと出力形式
- テンプレートの
種類 - テンプレートエディターで
作成した レイアウト、 Excel （xlsx）、 Word （docx）。 アップロードできる ファイルは 10MB までです。 - 出力形式
- レイアウトは
PDF、 Excel の テンプレートは Excel （xlsx） ・CSV、 Word の テンプレートは Word （docx） で 出力します。 Excel・Word から PDF への 変換は 行いません。 - CSV の
書き出し csvで改行 （CRLF・LF） ・ 最後の 行の あとの 改行・BOM・文字コード （UTF-8・Shift_JIS） ・引用符の 付け方を 指定できます。 省略時は UTF-8 （BOM 付き） ・CRLF です。 Shift_JIS で 表せない 文字が ある 場合は 422（ unencodable）を 返します。 - 一括発行
itemsに1〜1,000 件の データを 指定すると、 zip に まとめて 返却します。 レイアウトの テンプレートは merge: trueで1 つの PDF に 結合できます。 - 差し込み項目
{{customer.name}}、書式の 指定 {{total | number}}・{{date | date:YYYY年M月D日}}、繰り返し {{#items}}…{{/items}}、ページ番号 {{_page}}・{{_pages}}。- ファイル名
- テンプレートの
ファイル名の 設定 （例 請求書_{{number}}）に 拡張子を 付けます。 未設定の 場合は <テンプレート名>_<発行 ID>です。
レイアウトの
本番環境とテスト環境
プロジェクトごとに
- テスト環境の
API キー （ sk_test_）は、 下書きを 含む 最新バージョンで 発行します。 月間発行数には 含みません。 - 本番環境の
API キー （ sk_live_）は、 公開中の バージョンで 発行します。 公開中の バージョンが ない 場合は 409を返します。
認証
API キーをAuthorization: Bearer ヘッダーでDOCRELAY_API_KEY から
MCP 対応
DocRelay はhttps://api.docrelay.jp/mcp を
改ざん検知
ブロックチェーン技術を
詳細は