Download OpenAPI specification:Download
このドキュメントではeas APIを使ってできることの紹介やAPIリファレンスを提供します。
📋 目次
eas APIはeasテナント（またはその提携先）向けに提供されるWeb APIインターフェースです。
主な用途：
eas APIは2025年現在/v1エンドポイントを提供します。
eas APIは以下の3つの入稿方式をサポートします：
Base64形式入稿
ZIP形式入稿
PDF形式入稿
新たにeas APIをご利用頂く場合、以下の手順で設定を行います：
⚠️ 重要: APIとWebhookは基本的にセットで設定することを推奨します。
設定理由:
設定手順:
Webhook設定の詳細についてはWebhookセクションをご参照ください。
eas APIのご利用にあたっては以下につきご留意いただきますようお願い致します。
eas APIではWebhookの購読/購読解除をするAPIリソースやオプションを提供していませんが、eas本体側から対象となる仕様に対してオートメーションの設定することで、APIコンシューマー側への完成データの受け渡しを行うことができます。
⚠️ 重要: APIから入稿されたもののみがWebhookで通知されるわけではありません（eas本体側から入稿されたデータも通知されます）
例: eas APIとeas本体からの入稿がされる仕様で、WebhookではAPI経由で入稿されたものを扱いたい場合は、リクエスト・パラメーターのkeyなどから判別する必要があります。
📝 識別キーについて:
keyとzip_keyフィールドには、入稿時に指定したkeyパラメータの値がそのまま返却されますWebhookはeasテナントの構成上、原則的にNATを通して固定されたIPアドレスから送信されます。
推奨される認証方式:
X-WEBHOOK-SIGNATUREヘッダーに付与されるデジタル署名の検証署名検証の手順:
X-WEBHOOK-SIGNATUREから与えられるハッシュ値と同じであるかを確認200系または300系が返却されることで通知が正常に受け付けられたと判断400系や500系を返却した場合、最大5回までリトライエラー発生時にレスポンス・パラメーターのcodeはそれぞれ以下の値を返します。
| HTTPステータス・コード | code | message | 説明 |
|---|---|---|---|
| 500 | 0001 | unexpected error | APIエンドポイント側で予期せぬエラーが起きていることを表します |
| 401 | 0002 | unauthorized | APIキーが無効であることなどを表します |
| 405 | 0003 | method not allowed | 許可されていないメソッドであることを表します |
| 400 | 0004 | invalid parameter | リクエスト・パラメーターに不備があることなどを表します |
| 400 | 0005 | The maximum file size for one submission is 20MB | ペイロードのサイズが20MBを上回ったことを表します |
| 400 | 0006 | too many pages | リクエストされたファイルの中に51ページ以上のPDFが含まれていることを表します（2025年7月22日以降廃止予定） |
| 400 | 1000 | invalid defined_paper_id | 指定された仕様IDが存在しない、または入稿できない状態であることを表します |
| 400 | 1001 | base64 decode error | BASE64形式の文字列のデコードに失敗したことを表します |
| 400 | 1002 | invalid zip_upload_history_id | 指定された入稿履歴IDが存在しないことを表します |
注意事項:
codeやmessageはエンベロープ（レスポンスのメタ情報）という位置づけではなくエラー・オブジェクトのフィールドですcodeやmessageが含まれることはありません📞 お問い合わせ 更新履歴に関するご質問や、今後の機能追加についてのご要望がございましたら、弊社担当者までお気軽にお問い合わせください。
eas APIの更新履歴を記載しています。破壊的な変更や重要な機能追加については、事前にAPIコンシューマーに告知いたします。
| バージョン | 仕様変更日 | ドキュメント更新日 | 変更内容 |
|---|---|---|---|
| v0.5 | 2025年7月22日 | 2025年6月19日 | PDF形式入稿APIの改善：リクエスト時のページ数チェックを廃止し、51ページ以上のPDFは入稿後にエラー通知Webhookで処理結果を通知するように変更 |
| v0.4 | - | 2025年6月18日 | ドキュメントデザイン変更・説明文修正 |
複数の画像を含む単一の帳票データを入稿するためのインターフェース
特徴:
対応形式:
Base64エンコーディングされた画像をJSON形式でPOSTする方法
用途:
特徴:
| id required | integer 仕様ID |
| X-API-KEY required | string APIキー |
| key required | string 入稿識別キー 兼 帳票識別キー（UUIDなどユニークな文字列推奨） |
required | Array of objects |
Array of objects easでのデータチェックを目的とする場合に利用可能なチェック対象の入力データ（JSON文字列） |
{- "key": "bf98dc96-5a57-401a-aba3-b7106e08d39c",
- "images": [
- {
- "name": "example1.jpg",
- "body": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEBLAEsAAD/7ooooor/9k="
}
], - "input": [
- {
- "name": "電話番号",
- "input": "03-1111-2222"
}
]
}{- "id": 1234
}ZIPアーカイブをマルチパートでPOSTする方式
用途:
特徴:
| id required | integer 仕様ID |
| X-API-KEY required | string APIキー |
| key required | string 入稿識別キー 兼 帳票識別キー（UUIDなどユニークな文字列推奨） |
| file required | string <binary> ZIPファイル |
Array of objects easでのデータチェックを目的とする場合に利用可能なチェック対象の入力データ（JSON文字列） |
{- "id": 1234
}PDFファイルをマルチパートでPOSTする方式
用途:
特徴:
注意点（2025年7月22日以降）:
制限事項:
| id required | integer 仕様ID |
| X-API-KEY required | string APIキー |
| key required | string 入稿識別キー 兼 帳票識別キー（UUIDなどユニークな文字列推奨） |
| file required | string <binary> PDFファイル |
Array of objects easでのデータチェックを目的とする場合に利用可能なチェック対象の入力データ（JSON文字列） |
{- "id": 1234
}Webhook通知を介して完成したデータを受け取る機能
用途:
代替手段:
1帳票分のデータが完成したタイミングで通知
通知内容:
⚠️ タイムアウトについて:
| X-WEBHOOK-API-KEY | string APIキー |
| X-WEBHOOK-SIGNATURE | string HMAC署名 詳しくはWebhookをご参照下さい。 |
| id | integer 帳票ID |
| upload_id | integer 入稿ID |
| key | string 帳票識別キー（UUIDなどユニークな文字列推奨） 入稿時のkeyパラメータで指定した値がそのまま返却されます |
| zip_key | string 入稿識別キー（UUIDなどユニークな文字列推奨） 入稿時のkeyパラメータで指定した値がそのまま返却されます |
| defined_paper_id | integer 仕様ID |
| status | string ステータス データ化完了時には"success"のみを返却します |
Array of objects (chip) | |
| filenames | array 入稿ファイル名 |
| message | string メッセージ データ化成功時には"Finished to process"で返却します |
{- "id": 1234,
- "upload_id": 1234,
- "key": "bf98dc96-5a57-401a-aba3-b7106e08d39c",
- "zip_key": "bf98dc96-5a57-401a-aba3-b7106e08d39c",
- "defined_paper_id": 123,
- "status": "success",
- "chips": [
- {
- "id": 123,
- "defined_chip_id": 1001,
- "status": "verify_success",
- "verified_input": "000-1111-2222",
- "name": "電話番号",
- "key": "phone_number",
- "matrix_row_number": 1
}
], - "filenames": [
- "example1",
- "example2"
], - "message": "Finished to process"
}APIでの入稿後のデータ化処理で発生したエラーを通知
現在の対応範囲:
今後の予定:
| X-WEBHOOK-API-KEY | string APIキー |
| X-WEBHOOK-SIGNATURE | string HMAC署名 詳しくはWebhookをご参照下さい。 |
| id | integer 処理に失敗した場合はnullを返却します |
| upload_id | integer 入稿ID |
| key | string 帳票識別キー（UUIDなどユニークな文字列推奨） 入稿時のkeyパラメータで指定した値がそのまま返却されます |
| zip_key | string 入稿識別キー（UUIDなどユニークな文字列推奨） 入稿時のkeyパラメータで指定した値がそのまま返却されます |
| defined_paper_id | integer 仕様ID |
| status | string ステータス 処理失敗時には"failed"のみを返却します |
| chips | array 処理に失敗した場合は空配列を返却します |
| filenames | array 処理に失敗した場合は空配列を返却します |
| message | string エラーメッセージ 現状は"Failed to process uploaded files"のみを返却します |
{- "id": null,
- "upload_id": 1234,
- "key": "bf98dc96-5a57-401a-aba3-b7106e08d39c",
- "zip_key": "bf98dc96-5a57-401a-aba3-b7106e08d39c",
- "defined_paper_id": 123,
- "status": "failed",
- "chips": [ ],
- "filenames": [ ],
- "message": "Failed to process uploaded files"
}Webhook失敗時の代替データ取得機能
用途:
納品データを入稿単位で取得可能なAPI
用途:
注意事項:
| id required | integer 仕様ID |
| zipUploadHistoryID required | integer 入稿ID API入稿時に返却されるID、管理画面の入稿一覧からもご確認いただけます |
| X-API-KEY required | string APIキー |
{- "id": 1234,
- "upload_id": 1234,
- "key": "bf98dc96-5a57-401a-aba3-b7106e08d39c",
- "zip_key": "bf98dc96-5a57-401a-aba3-b7106e08d39c",
- "defined_paper_id": 123,
- "status": "processed",
- "papers": [
- {
- "id": 12203,
- "chips": [
- {
- "id": 123,
- "defined_chip_id": 1001,
- "status": "verify_success",
- "verified_input": "000-1111-2222",
- "name": "電話番号",
- "key": "phone_number",
- "matrix_row_number": 1
}
], - "filenames": [
- "example1"
]
}
]
}