# DocRelay の概要

> DocRelay の概要。テンプレートの作成、API による帳票の発行、本番環境とテスト環境、MCP 対応、改ざん検知について説明します。提供開始に向けて準備中のため、仕様は変更する場合があります。

Source: https://docrelay.jp/docs/

DocRelay は、管理画面のテンプレートエディターで帳票のレイアウトを作成し、API でデータを送信して PDF を発行するサービスです。現在、提供開始に向けて準備中です。本ページの内容は、提供開始までに変更する場合があります。

## 提供状況

- 提供開始に向けて準備中です。
- 管理画面（[app.docrelay.jp](https://app.docrelay.jp/signup)）から事前登録できます。事前登録いただいた方には、提供開始時にお知らせします。
- プランと料金は[料金表](https://docrelay.jp/#pricing)に掲載しています（Free プランあり。月額・税別）。
- ご相談は[お問い合わせ](https://docrelay.jp/contact/)から承ります。

## 利用の流れ

1. 管理画面でテンプレートを作成します。テンプレートエディターでテキスト・線・矩形・画像・明細テーブル・本文を配置するか、差し込み項目を記述した Excel・Word ファイルをアップロードします。
2. サンプルデータでプレビューし、テスト環境の API キーで発行を確認します。
3. テンプレートのバージョンを公開します。本番環境の API キーは、公開中のバージョンで発行します。
4. `POST /v1/renders` に、テンプレート名・出力形式・データを指定して送信します。
5. `wait` 秒以内に完了すれば、帳票をその場で返却します。完了しない場合は `202` で ID を返し、完了時に Webhook（`render.succeeded`）で通知します。
6. 発行した帳票は、有効期限付き 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 リファレンス](https://docrelay.jp/docs/api/#layout) をご覧ください。

## 本番環境とテスト環境

プロジェクトごとに本番環境とテスト環境があります。テンプレートはプロジェクト単位で管理し、両方の環境で共通です。発行履歴は環境ごとに分かれます。

- テスト環境の API キー（`sk_test_`）は、下書きを含む最新バージョンで発行します。月間発行数には含みません。
- 本番環境の API キー（`sk_live_`）は、公開中のバージョンで発行します。公開中のバージョンがない場合は `409` を返します。

## 認証

API キーを `Authorization: Bearer` ヘッダーで送信します。API キーは管理画面で発行し、スコープを指定します。コードサンプルでは、環境変数 `DOCRELAY_API_KEY` から読み込んでいます。

## MCP 対応

DocRelay は MCP（Model Context Protocol）に対応しています。Claude などの AI クライアントに `https://api.docrelay.jp/mcp` を追加し、管理画面のアカウントでログインすると、テンプレートの作成・レイアウトの編集・公開、帳票の発行、発行履歴の確認を AI から行えます。権限は管理画面と同じロールで判定します。

## 改ざん検知

ブロックチェーン技術を応用した改ざん検知を備えています。発行した帳票の SHA-256・発行 ID・テンプレートとバージョン・日時を、1 つ前の記録と連結して順に記録し、日次ハッシュを公開します。差し込んだデータそのものは記録しません。

詳細は [API リファレンス](https://docrelay.jp/docs/api/#ledger) をご覧ください。