Вступ до API
Технологія штучного інтелекту, спеціалізована на виявленні підробок, стала простішою, ніж коли-небудь, завдяки використанню API ImgAuth.com. Лише кількома рядками коду ви можете внедрити цю технологію у своє застосування.
- Параметри Запиту
- Дані зображення в Base64 з подальшим URL-кодуванням. Максимум 10 MB. Коротка сторона не менше 512 px, довга сторона не більше 8192 px. Підтримуються jpg/jpeg/png/bmp. Передайте image або url.
- Параметри відповіді
- Довідник полів відповіді API
Вступ до API
- фінансові команди перевіряють рахунки та квитанції
- HR перевіряє сертифікати й скани
- страхові команди перевіряють документи заяв
Аутентифікація
Замініть {your-api-domain} на endpoint API, показаний на панелі акаунта.
Автентифікуйте запити за допомогою endpoint API вашого акаунта та Bearer-токена. Після покупки API-кредитів ви можете переглянути endpoint і токен на панелі акаунта. Зберігайте токен у таємниці та ніколи не публікуйте його у відкритих репозиторіях.
POSThttps://api.imgauth.com/v1/document-fraud-detection
Authorization: Bearer {YOUR_API_TOKEN}
Content-Type: application/json; charset=UTF-8
Content-Type: application/json; charset=UTF-8
Параметри Запиту
| Параметр | Тип | ✓ | Опис |
|---|---|---|---|
| image | string | ✓ | Дані зображення в Base64 з подальшим URL-кодуванням. Максимум 10 MB. Коротка сторона не менше 512 px, довга сторона не більше 8192 px. Підтримуються jpg/jpeg/png/bmp. Передайте image або url. |
| detect_proportion | boolean | — | Чи потрібно повертати рівень впевненості у підробці. Значення за замовчуванням: false. true повертає показник, false — ні. |
| return_heatmap | boolean | — | Чи потрібно повертати heatmap підробки. Значення за замовчуванням: false. true повертає Base64 heatmap, false — ні. |
| location | boolean | — | Використайте ці приклади для створення та налагодження вашої інтеграції |
Приклад HTTP Запиту
{
"image": "<BASE64_IMAGE_WITHOUT_PREFIX>",
"detect_proportion": true,
"return_heatmap": true,
"location": true
}Параметри відповіді
| Параметр | Тип | Опис |
|---|---|---|
| code | integer | Довідник кодів відповідей API |
| request_id | string | Використайте ці приклади для створення та налагодження вашої інтеграції |
| data.detection_result | "fake" | "real" | Результат перевірки: "fake" означає, що підробку виявлено, "real" — що підробку не виявлено. |
| data.tampered_proportion | number | null | Рівень впевненості у підробці, повертається коли detect_proportion = true. |
| data.heatmap | string | null | Base64 heatmap підозрілих областей, повертається коли return_heatmap = true. |
| data.tampered_location | array | Масив координат підозрілих областей, повертається коли probability більша або дорівнює restrict_probability. Кожен елемент містить left, top, width, height і probability. |
Приклади Відповідей
{
"code": 0,
"request_id": "req_01...",
"data": {
"detection_result": "fake",
"tampered_proportion": 0.82,
"heatmap": "<BASE64_HEATMAP>",
"tampered_location": [
{ "left": 124, "top": 86, "width": 220, "height": 74, "probability": 0.91 }
]
}
}Коди Помилок
400INVALID_REQUESTAPI messages відображаються як сирі значення upstream-сервісу, щоб точно збігатися з відповідями у продакшені.
401INVALID_API_KEYAPI messages відображаються як сирі значення upstream-сервісу, щоб точно збігатися з відповідями у продакшені.
402CREDITS_EXHAUSTEDAPI messages відображаються як сирі значення upstream-сервісу, щоб точно збігатися з відповідями у продакшені.
403API_KEY_INACTIVE / API_KEY_EXPIREDAPI messages відображаються як сирі значення upstream-сервісу, щоб точно збігатися з відповідями у продакшені.
413PAYLOAD_TOO_LARGEAPI messages відображаються як сирі значення upstream-сервісу, щоб точно збігатися з відповідями у продакшені.
415UNSUPPORTED_IMAGEAPI messages відображаються як сирі значення upstream-сервісу, щоб точно збігатися з відповідями у продакшені.
502UPSTREAM_ERRORAPI messages відображаються як сирі значення upstream-сервісу, щоб точно збігатися з відповідями у продакшені.
504UPSTREAM_TIMEOUTAPI messages відображаються як сирі значення upstream-сервісу, щоб точно збігатися з відповідями у продакшені.
Приклади Коду
curl -X POST "https://api.imgauth.com/v1/document-fraud-detection" \
-H "Authorization: Bearer rh_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"image": "<BASE64_IMAGE_WITHOUT_PREFIX>",
"detect_proportion": true,
"return_heatmap": true,
"location": true
}'