MAXScanner API v1
処理基盤ではなく、文書ワークフローを作ろう。
ドキュメント、ファイル、OCR、変換、PDF、圧縮、Webhook のための非同期ファースト API。認証モデル、ジョブのライフサイクル、結果の契約はそれぞれひとつに統一されています。
認証
スコープ付き API キー
処理
非同期ジョブ
イベント
署名付き Webhook
リファレンス
すべての API 操作
POST
/api/v1/jobs処理ジョブを作成
非同期の処理操作を送信し、安定したジョブ ID を受け取ります。
GET
/api/v1/jobs/{jobId}ジョブの状態を取得
処理ジョブの現在のライフサイクル状態と結果情報を読み取ります。
GET
/api/v1/documentsドキュメントを一覧表示
認証済みアカウントで利用できるドキュメントを一覧表示します。
POST
/api/v1/documents/{documentId}/processドキュメントを処理
アカウント内のドキュメントのバージョンに対して、非同期の処理ジョブを作成します。
POST
/api/v1/files/uploadファイルのアップロードを許可
非公開のソースファイル向けに、上限付きのアップロードワークフローを作成します。
POST
/api/v1/convertファイルを変換
対応する文書変換を、管理されたプロセッサー群に振り分けます。
POST
/api/v1/ocrOCR を実行
対応する画像や文書から検索可能なテキストを抽出します。
POST
/api/v1/pdfPDF 操作を実行
結合、分割、最適化など、対応する PDF 操作を送信します。
POST
/api/v1/compress画像を圧縮
形式と品質の条件を指定して画像最適化ジョブを送信します。
POST
/api/v1/webhooksWebhook を作成
ジョブやドキュメントのイベント用に、署名付きのコールバック先を登録します。
GET
Error referenceエラーリファレンス
認証、検証、利用枠、競合、サーバーのエラーを理解します。
GET
Limits & formats上限と形式
対応形式、利用枠、リクエストの制約を確認します。