Перейти до основного вмісту
У цьому документі буде представлено інструкцію з інтеграції 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 становить одну тисячу, при порозі 80 - одну десяту тисячі).
  • 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. Якщо у вас є будь-які питання, будь ласка, звертайтеся до нашої команди технічної підтримки.