APIドキュメント

ご利用方法

1. ファイルをアップロードする

まず、ファイルをアップロードするために以下のAPIエンドポイントを呼び出します:

POST /api/public1/uploads

レスポンスとして、アップロードされたファイルに対応する upload.id が返されます。この upload.id を次のステップで使用するために保存しておきます。

2. OCR処理のステータス確認

次に、保存しておいた upload.id を使って、OCR処理が完了するまで定期的にステータスを確認します。以下のAPIを10秒ごとに呼び出してください:

GET /api/public1/uploads/{upload.id}

レスポンスには、ページごとに分解された ocr.id が含まれます。 status フィールドが "ocred" になるまでこのリクエストを繰り返します。 "ocred" になると、OCR処理が完了したことを意味します。

3. 文字認識の確認・修正UIの表示(スキップ可)

OCR処理が完了した後、文字認識結果に誤りがないか確認・修正するために次のAPIエンドポイントを呼び出します:

GET /api/public1/modify/ocrs/{ocr.id}/edit?token={ocr.token}

この操作にはトークンが必須です。トークンは、OCR処理が完了した後に取得でき、swaggerドキュメントで確認できます。

このエンドポイントをframeまたはブラウザで開くことで、OCRによって認識されたテキストと対応する画像を確認できます。認識結果に誤りがある場合、画面上で修正を行い、修正が完了したら「保存」ボタンを押して修正内容を確定します。

4. OCR結果の取得

OCR処理が完了し、必要な修正が行われたら、取得した ocr.id を使用して、最終的なテキストデータを取得します。以下のAPIエンドポイントを呼び出します:

GET /api/public1/ocrs/{ocr.id}

レスポンスには、OCRで読み取られ、修正された文字データが含まれています。