Перейти к основному содержимому
Получение селфиGET

Чтение селфи, снятого для процесса, по id, который Human Plugin вернул при создании.

Markdown

GET /v1/processes/{id}/selfie

id — это UUID из ответа на создание. У запроса нет ни тела, ни query-параметров.

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У процесса нет селфи: захвата не было, процесс завершился неудачей до его начала или селфи больше недоступно
4xxmessage отказаЗапрос отклонён. Причина указана в message и details
502UPSTREAM_UNAVAILABLEНе удалось получить селфи вовремя. Повторите позже
503DATABASE_UNAVAILABLEСбой базы данных. Повторите позже

Чтение безопасно повторять. Ответ 404 при повторе не меняется.

Далее​

Жизненный цикл процесса