API利用

各機能のエンドポイント・パラメータ・レスポンスの詳細仕様は、デベロッパーポータルのAPIリファレンスの各エンドポイントに記載しています（「デベロッパーポータル」参照）。

• ワークスペースでAPI機能オプションが有効になっている必要があります（有効化はお問い合わせください）
• API管理画面の操作には管理者権限（管理者／ワークスペース管理者）が必要です
• ワークスペースにIPアドレス制限を設定している場合、APIリクエストにも同じ制限が適用されます

アクセストークンの発行link

1. 「アクセストークン」タブで「トークンを作成」を選択します
2. トークン名（例：開発用APIトークン）と有効期限を指定して作成します
   • 有効期限は1ヶ月（デフォルト）／3ヶ月／6ヶ月／1年／無制限から選択できます
3. 作成直後に表示されるトークンをコピーして、安全な場所に保管してください

• トークンは複数発行できます（用途ごとの発行を推奨）
• 不要になったトークンは一覧から「無効化」できます。無効化は取り消せません
• トークンには発行したユーザーの権限がそのまま適用されます。また、閲覧・無効化できるのは自分が発行したトークンのみです

事前定義エンドポイントの発行link

特定のドキュメントタイプ専用の解析URLを発行できます。

1. 「エンドポイント」タブで「APIを作成」を選択します
2. 解析タイプ（ドキュメントタイプ、または「自動判定」）とメモを指定して作成します
3. 専用URL POST /api/v2/analyse/{コード} が発行されます。このURLにファイルを送信すると、指定したドキュメントタイプで解析されます

• 不要になったエンドポイントは無効化できます
• 呼び出し履歴はログに記録されます

Authorization: Bearer <アクセストークン>

認証に失敗した場合は401が返ります（トークン未指定／不正／期限切れ／無効化済み）。

1. 解析の開始 — POST /api/v2/analyse にファイルを送信します（multipart/form-data、file 必須。ドキュメントタイプIDやプロジェクトの指定も可能）。受付されると202でドキュメントIDが返ります
2. ステータス確認 — GET /api/v2/analyse_status/{document_id} で解析状況を確認します。2〜5秒間隔でのポーリングを推奨します
3. 結果取得 — ステータスが完了になったら GET /api/v2/document_with_analysis_result/{document_id} で解析結果を取得します

主なステータス値：pending（受付済）→ text_extracting（テキスト抽出中）→ ai_analyzing（解析中）→ completed（完了）。失敗時はtext_extract_failed / ai_analyze_failedなどになります。

時間のかかる処理（一括操作・書類生成など）は非同期APIとして提供されており、GET /api/v2/async_processes/{id}/status で進捗を確認できます。

上記は基本フローの概要です。各APIの必須パラメータ・オプション・レスポンスの詳細は、APIリファレンスの各エンドポイントの記載を参照してください。

• ガイド：はじめに／認証／リクエストとレスポンス／ページネーション／エラーハンドリング／レート制限とクレジット／非同期処理／変更履歴
• APIリファレンス：全公開エンドポイントのパラメータ・レスポンス仕様、cURLサンプルの自動生成、画面上から実リクエストを送れる「Try it」機能
• 日本語／英語の切り替え、キーワード検索（Ctrl+K / ⌘K）に対応しています

システムへの組み込みについて

お客様のシステムへの組み込みは、デベロッパーポータルのAPIリファレンスを参照のうえ、お使いの開発言語で実装してください。APIは標準的なHTTP（REST）で提供しているため、HTTPリクエストを送信できる言語・環境であれば利用できます。リファレンスには各エンドポイントのリクエストサンプル（cURL形式）を掲載していますので、実装時の参考にしてください。

{ "error": "エラーメッセージ" }

バリデーションエラー時はフィールドごとの詳細、一部のエラーではエラーコード付きの形式（{ "error": { "code": "...", "message": "..." } }）が返ります。