APIドキュメント
 
API メソッド
概要
フォームをスキャンして認識結果を得るには、base64とフィールド情報の両方で有効なテンプレートのデータとイメージデータと一緒に、POST/フォームエンドポイントに対してリクエストを送信する必要があります。フィールド情報を特定し、有効なJSONの構造を構築するために、 tegaki-editorをご利用いただくことを強く推奨いたします。
Request ID
requestId は、手書き認識リクエストのステータスをチェックするためのチケット番号として機能する文字列です。requestIdを通じて、ユーザーは個々の要求の状態を確認できます。操作中に問題が発生した場合は、このrequestIdを参照して問題を追跡する必要があります。
有効な構造を持つJSONをリクエストとして送信
ペイロードとメソッドを認証するためには、APIドキュメントをご参照ください。 fields を特定し、有効なフィールドデータの構造を構築するためには、 tegaki-editorをご利用いただくことを強く推奨いたします。
Workflow
1POST /form
フォームを送信して、 requestId を取得します。
2GET /form/{requestId}
requestIdを用いることで、読取り処理の状態を確認できます。
1POST /form
クライアント
リクエスト
HTTP POST
tegakiから発行された有効な API_KEY といっしょに、ペイロードと一緒にリクエストを送信します。ペイロードには、templateData、imageData、version、そして、fieldsのパラメーター情報が含まれます。
レスポンス
受領
{
  requestId: string
}
リクエストに成功すると、有効な requestIdが返されます。requestIdは、読取りリクエストの状態を確認するためのチケット番号として機能します。
レスポンス
エラー
{
  requestId: string
  errors: array(Error)
}
リクエストに失敗した場合には、有効なrequestIdと、エラー詳細が返されます。
2GET /form/{requestId}
クライアント
リクエスト
POSTリクエストから requestId を取得した後は、GETリクエストによりプロセスの状態をご確認いただけます。
レスポンス
受領
{
  state:
    RUNNING/
    COMPLETED/
    FAILED
}
リクエストが成功すると、処理状況を伝える状態を返します。 RUNNING, COMPLETED, FAILED の3つの状態が存在します。
RUNNING
サービスがリクエストを処理していることを示します。
COMPLETED
サービスがタスクを完了し、レスポンスが読取り結果を保持していることを示します。
FAILED
サービスがタスクの処理に失敗し、レスポンスには発生したエラーの詳細が記載されていることを示します。
レスポンス
エラー
{
  requestId: string
  errors: array(Error)
}
リクエストが失敗した場合、関連するエラーの詳細の配列が返されます。