Перейти к основному содержанию

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

В этой статье будет представлена инструкция по интеграции API статического обнаружения живого лица (высокоточная версия), который можно использовать для проверки загруженных пользователем статических изображений на наличие подделок.

​
Процесс подачи заявки

Чтобы использовать API, сначала необходимо перейти на соответствующую страницу API статического обнаружения живого лица (высокоточная версия) и подать заявку на соответствующую услугу. После перехода на страницу нажмите кнопку «Acquire», как показано на изображении: Если вы еще не вошли в систему или не зарегистрированы, вас автоматически перенаправит на страницу входа, где вам будет предложено зарегистрироваться и войти в систему. После регистрации и входа вы автоматически вернетесь на текущую страницу. При первой подаче заявки будет предоставлен бесплатный лимит, который можно использовать для бесплатного доступа к этому API.

​
Основное использование

Сначала ознакомьтесь с основным способом использования, который заключается в том, что нужно ввести ссылку на изображение, чтобы получить обработанное изображение. Сначала необходимо просто передать поле image_url, изображение лица показано на следующем изображении:

Далее мы можем заполнить соответствующие поля на интерфейсе, как показано на изображении:

Здесь мы настроили заголовки запроса, включая:
  • accept: в каком формате вы хотите получить ответ, здесь указано application/json, то есть в формате JSON.
  • authorization: ключ для вызова API, после подачи заявки его можно выбрать из выпадающего списка.
Также настроено тело запроса, включая:
  • image_url: ссылка на изображение лица, которое нужно обработать.
  • face_model_version: версия алгоритма модели, используемая для распознавания лиц. В настоящее время поддерживается версия «3.0».
После выбора можно заметить, что справа также сгенерирован соответствующий код, как показано на изображении:

Нажмите кнопку «Try», чтобы провести тестирование, как показано на изображении, и мы получим следующий результат: 
{
  "score": 0,
  "face_model_version": "3.0"
}
Теперь мы получили результат статического обнаружения живого лица, включая информацию о балле живости. Описание полей следующее:
  • score: балл живости, диапазон значений [0,100], в зависимости от порогового значения, чтобы определить, является ли изображение подделкой. В настоящее время пороги могут быть [5,10,40,70,90], из которых рекомендуемое значение - 40.
  • face_model_version: версия алгоритма, используемого для распознавания лиц.
Если вы хотите сгенерировать соответствующий код интеграции, вы можете просто скопировать его, например, код CURL выглядит следующим образом: 
curl -X POST 'https://api.xhuoapi.ai/v1/face/detect-live' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": "https://cdn.xhuoapi.ai/lrbtcn.jpg"
}'
Код интеграции на Python выглядит следующим образом: 
import requests

url = "https://api.xhuoapi.ai/v1/face/detect-live"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "image_url": "https://cdn.xhuoapi.ai/lrbtcn.jpg"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Обработка ошибок

При вызове API, если возникнет ошибка, API вернет соответствующий код ошибки и информацию. Например:
  • 400 token_mismatched: Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
  • 400 api_not_implemented: Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
  • 401 invalid_token: Неавторизованный, недействительный или отсутствующий токен авторизации.
  • 429 too_many_requests: Слишком много запросов, вы превысили лимит частоты.
  • 500 api_error: Внутренняя ошибка сервера, что-то пошло не так на сервере.

​
Пример ответа об ошибке

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Заключение

С помощью этого документа вы узнали, как использовать API статического обнаружения живого лица (высокоточная версия) для проверки загруженных пользователем статических изображений на наличие подделок. Надеемся, что этот документ поможет вам лучше интегрировать и использовать этот API. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.