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

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

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

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

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

Как видно, мы настроили заголовки запроса, включая:
  • accept: в каком формате вы хотите получить ответ, здесь указано application/json, то есть в формате JSON.
  • authorization: ключ для вызова API, который можно выбрать из выпадающего списка после подачи заявки.
Также настроено тело запроса, включая:
  • image_url: ссылка на изображение удостоверения личности, которое нужно обработать.
  • config: необязательный параметр конфигурации, булевое поле, по умолчанию все значения false, поддерживает copy_warn, border_check_warn, reshoot_warn, detect_ps_warn, temp_id_warn, quality (порог 0-100).
После выбора можно заметить, что справа также сгенерирован соответствующий код, как показано на изображении:

Нажмите кнопку «Try», чтобы провести тестирование, как показано на изображении, и мы получим следующий результат:
{
  "sim": 99.76,
  "result": "Success",
  "description": "成功",
  "name": "身份证姓名",
  "sex": "身份证性别",
  "nation": "身份证民族",
  "birth": "身份证生日",
  "address": "身份证家庭住址",
  "id_num": "身份证号码",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}
Возвращаемый результат содержит несколько полей, описание которых приведено ниже:
  • sim: степень сходства, диапазон значений [0.00, 100.00]. Рекомендуется считать, что степень сходства 70 и выше указывает на то, что это один и тот же человек, порог можно настроить в зависимости от конкретной ситуации (порог 70 имеет вероятность ложного срабатывания 0.1%, порог 80 - 0.01%).
  • result: код ошибки бизнеса, в случае успеха возвращает Success, в случае ошибки смотрите раздел с кодами ошибок ниже в части FailedOperation.
  • description: результат проверки имени и номера удостоверения личности.
  • name: информация о имени в удостоверении личности, если изображение удостоверения не загружено, то поле пустое.
  • sex: информация о поле в удостоверении личности, если изображение удостоверения не загружено, то поле пустое.
  • nation: информация о национальности в удостоверении личности, если изображение удостоверения не загружено, то поле пустое.
  • birth: информация о дате рождения в удостоверении личности, если изображение удостоверения не загружено, то поле пустое.
  • address: информация о домашнем адресе в удостоверении личности, если изображение удостоверения не загружено, то поле пустое.
  • id_num: информация о номере удостоверения личности, если изображение удостоверения не загружено, то поле пустое.
  • portrait: base64 кодировка фотографии на удостоверении личности, если вырезка не удалась, будет использовано полное изображение удостоверения для сравнения и возвращено пустое значение.
  • warnings: информация о предупреждениях, если в конфигурации настроены предупреждения, сравнение лиц будет остановлено, результат вернет ошибку (FailedOperation.OcrWarningOccurred) и будет содержать эту информацию о предупреждении.
  • quality: оценка качества изображения, этот параметр имеет значение только если в конфигурации запроса настроено предупреждение о размытости изображения, диапазон значений (0-100), в настоящее время порог по умолчанию составляет 50, значение ниже 50 вызовет предупреждение о размытости.
  • encryption: информация о шифровании конфиденциальных данных.
Можно увидеть, что информация удостоверения личности обладает высокой степенью подлинности. Кроме того, если вы хотите сгенерировать соответствующий код интеграции, вы можете просто скопировать его, например, код CURL выглядит следующим образом:
curl -X POST 'https://api.acedata.cloud/identity/idcard/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'
Код интеграции на Python выглядит следующим образом:
import requests

url = "https://api.acedata.cloud/identity/idcard/check-1e"

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

payload = {
    "image_url": {image_url}
}

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. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.