API とウェブフック

領収書や請求書のアップロードと読み取りは、REST APIを介して利用可能です。アカウント、フォルダー、タグ、および接続の管理はアプリケーション内で行います。

キー

設定 → 開発者用にて作成します。キーは一度だけ表示され、作成時に確認できます。その後はハッシュだけが保存されるため、再度表示されることはありません。失われたキーは再発行されず、新しいキーを作成し、古いキーは削除されます。最大5つのキーを持つことができ、それぞれ最大2年の有効期限を設定できます。

キーはヘッダー X-API-Key で送信されます。

操作	説明
`POST /api/upload`	ファイルのアップロードとオプション: 形式、方向、タイプ、通貨、スキーム、フォルダー、ウェブフック
`POST /api/upload/url`	同様の操作をパブリックアドレスから; ファイルを自分でダウンロードします
`GET /api/jobs`	フィルタとページネーションを伴う領収書の一覧
`GET /api/jobs/{id}`	ステータス、読み取ったデータ、発見、およびターゲット形式での結果
`GET /api/jobs/{id}/original`	アップロードされたファイル
`DELETE /api/jobs/{id}`	ゴミ箱に削除

Excel と PDF は結果として Base64 形式で提供されます。結果が不要な場合は、includeResult=false を送信することで、サーバー側での変換を省略できます。

OpenAPI形式のインターフェースは /api/docs で確認できます; これは設定内のキーの近くにあるリンクです。説明は実行中のコードから生成されるため、APIの機能と一致します。

送信前の確認は、デフォルト設定ではキーでアップロードされた領収書にも適用されます: 領収書はアプリケーションでの確認を待ち、その後にウェブフックが送信されます。画面の前に誰もいない統合を構築する場合は、設定 → 送信前の確認で API チャネルを削除するか、確認をオフにします。

AIエージェント用の MCP サーバーは /api/mcp にあり、同じキーを使用します。ドキュメントを読み取り、検索することはできますが、アップロードはできません; アップロードはエージェントが自分で実行するコマンドとして返されます。

状態を確認する代わりに、処理が完了したときに結果を送信させることができます。アドレスは設定 → 開発者用でアカウント全体に設定するか、個別のアップロードでパラメータ targetWebhookUrl で指定します。設定内のボタンを押すことでテストメッセージが送信されます。

POSTリクエストがJSON形式で送信されます: 領収書の識別子、ファイル名、形式、およびターゲット形式での結果。領収書が確認を通過したり再処理された場合、IsCorrection フラグとともに二度目のウェブフックが送信されます。

メッセージには署名されません。自分の秘密トークンをアドレスに追加することで送信者を確認してください。プライベートネットワークへのアドレスは拒否されます。

配信に失敗した場合、11回の試行が約4時間半の間隔を空けて繰り返されます。各試行は活動内であなたの側の応答とともに記録されます; 領収書のリストでは配信結果を示すアイコンがあります。

APIには1分あたりの呼び出しの制限はありません; アップロードはクレジット、ファイルサイズ（プランによって）および領収書あたり20ページに制限されています。拒否されると、理由を示す400エラーが返されます。MCP サーバーは1秒あたり10クエリに制限されています。

キーはヘッダー X-API-Key で送信されます。

操作	説明
`POST /api/upload`	ファイルのアップロードとオプション: 形式、方向、タイプ、通貨、スキーム、フォルダー、ウェブフック
`POST /api/upload/url`	同様の操作をパブリックアドレスから; ファイルを自分でダウンロードします
`GET /api/jobs`	フィルタとページネーションを伴う領収書の一覧
`GET /api/jobs/{id}`	ステータス、読み取ったデータ、発見、およびターゲット形式での結果
`GET /api/jobs/{id}/original`	アップロードされたファイル
`DELETE /api/jobs/{id}`	ゴミ箱に削除

Excel と PDF は結果として Base64 形式で提供されます。結果が不要な場合は、includeResult=false を送信することで、サーバー側での変換を省略できます。