メインコンテンツへスキップ
セルフィーの取得GET

作成時に Human Plugin が返した id を使って、プロセスで取得したセルフィーを読み取ります。

Markdown

GET /v1/processes/{id}/selfie

id は作成レスポンスに含まれる UUID です。リクエストにボディやクエリパラメーターはありません。

curl http://human-plugin.internal:8080/v1/processes/17e4546e-6109-4240-8c0b-4ba98474a104/selfie

Human Plugin はセルフィーのコピーを保持しません。呼び出しのたびに再取得します。

レスポンス​

200 OK で、base64 の画像とその種類を返します。

{
  "fileContents": "/9j/4AAQSkZJRgABAQAAAQABAAD…",
  "contentType": "image/jpeg"
}

ファイルとして保存するには:

curl -s http://human-plugin.internal:8080/v1/processes/17e4546e-6109-4240-8c0b-4ba98474a104/selfie \
  | jq -r .fileContents | base64 -d > selfie.jpg

利用可能性​

  • セルフィーがあるのは、セルフィーが存在したプロセスのみです。imageBase64 で送信されたもの、または本人から取得されたものが対象です。
  • Journey フローでは、本人が撮影した後にはじめてセルフィーが存在します。それまでは、リクエストは 400 で拒否され、message は process state must be finished で始まります。まずプロセスを読み取り、PROCESS_STATE_FINISHED になってからセルフィーを取得してください。
  • セルフィーは、プロセスの完了後、限られた期間のみ利用できます。後で必要な場合は、このレスポンスから保存してください。

画像の取り扱い​

セルフィーは生体データです。Human Plugin はセルフィーを保存もログ記録もせず、レスポンスは Cache-Control: no-store で送信されます。ゲートウェイやアプリケーションのログにも含めないでください。

エラー​

ステータスmessage意味
400process state must be finished…Journey プロセスで、撮影がまだ完了していません。先にプロセスを読み取ってください
404PROCESS_NOT_FOUNDid が UUID ではないか、不明です
404SELFIE_NOT_FOUNDプロセスにセルフィーがありません。撮影がなかった、開始前に失敗した、またはセルフィーがすでに利用できません
4xx拒否時の messageリクエストが拒否されました。理由は message と details にあります
502UPSTREAM_UNAVAILABLEセルフィーを時間内に取得できませんでした。後で再試行してください
503DATABASE_UNAVAILABLEデータベースが失敗しました。後で再試行してください

読み取りは安全に再試行できます。404 は再試行しても変わりません。

次へ​

プロセスのライフサイクル

最終更新 に