Úvod do API
Technologie umělé inteligence specializovaná na detekci padělků byla díky API ImgAuth.com usnadněna více než kdy dříve. Pouhými několika řádky kódu můžete tuto technologii přinést do své aplikace.
- Parametry požadavku
- Obrazová data zakódovaná v Base64 a následně URL-encoded. Maximálně 10 MB. Kratší strana alespoň 512 px a delší strana nejvýše 8192 px. Podporuje jpg/jpeg/png/bmp. Zadejte image nebo url.
- Parametry odpovědi
- Reference polí odpovědi API
Úvod do API
- finanční týmy kontrolují faktury a účtenky
- HR týmy kontrolují certifikáty a skeny
- pojišťovny kontrolují škodní dokumenty
Ověření
Nahraďte {your-api-domain} API endpointem zobrazeným v panelu účtu.
Autentizujte požadavky pomocí API endpointu svého účtu a Bearer tokenu. Po zakoupení API kreditů můžete endpoint a token zobrazit v panelu účtu. Uchovávejte token v tajnosti a nikdy jej necommitujte do veřejných repozitářů.
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
Parametry požadavku
| Parametr | Typ | ✓ | Popis |
|---|---|---|---|
| image | string | ✓ | Obrazová data zakódovaná v Base64 a následně URL-encoded. Maximálně 10 MB. Kratší strana alespoň 512 px a delší strana nejvýše 8192 px. Podporuje jpg/jpeg/png/bmp. Zadejte image nebo url. |
| detect_proportion | boolean | — | Určuje, zda vrátit skóre jistoty manipulace. Výchozí hodnota: false. true vrací skóre, false ne. |
| return_heatmap | boolean | — | Určuje, zda vrátit heatmapu padělání. Výchozí hodnota: false. true vrací Base64 heatmapu, false ji nevrací. |
| location | boolean | — | Použijte tyto příklady k vytvoření a ladění vaší integrace |
Ukázkový HTTP požadavek
{
"image": "<BASE64_IMAGE_WITHOUT_PREFIX>",
"detect_proportion": true,
"return_heatmap": true,
"location": true
}Parametry odpovědi
| Parametr | Typ | Popis |
|---|---|---|
| code | integer | Referenční příručka pro kódy odpovědí API |
| request_id | string | Použijte tyto příklady k vytvoření a ladění vaší integrace |
| data.detection_result | "fake" | "real" | Výsledek manipulace: "fake" znamená zjištěnou manipulaci, "real" znamená, že manipulace zjištěna nebyla. |
| data.tampered_proportion | number | null | Skóre jistoty manipulace, vrácené při detect_proportion = true. |
| data.heatmap | string | null | Base64 heatmapa manipulovaných oblastí, vrácená při return_heatmap = true. |
| data.tampered_location | array | Pole souřadnic podezřelých oblastí, vrácené pokud je probability větší nebo rovna restrict_probability. Každá položka obsahuje left, top, width, height a probability. |
Ukázkové odpovědi
{
"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 }
]
}
}Chybové kódy
400INVALID_REQUESTAPI messages se zobrazují jako surové hodnoty upstream služby, aby přesně odpovídaly odpovědím v produkci.
401INVALID_API_KEYAPI messages se zobrazují jako surové hodnoty upstream služby, aby přesně odpovídaly odpovědím v produkci.
402CREDITS_EXHAUSTEDAPI messages se zobrazují jako surové hodnoty upstream služby, aby přesně odpovídaly odpovědím v produkci.
403API_KEY_INACTIVE / API_KEY_EXPIREDAPI messages se zobrazují jako surové hodnoty upstream služby, aby přesně odpovídaly odpovědím v produkci.
413PAYLOAD_TOO_LARGEAPI messages se zobrazují jako surové hodnoty upstream služby, aby přesně odpovídaly odpovědím v produkci.
415UNSUPPORTED_IMAGEAPI messages se zobrazují jako surové hodnoty upstream služby, aby přesně odpovídaly odpovědím v produkci.
502UPSTREAM_ERRORAPI messages se zobrazují jako surové hodnoty upstream služby, aby přesně odpovídaly odpovědím v produkci.
504UPSTREAM_TIMEOUTAPI messages se zobrazují jako surové hodnoty upstream služby, aby přesně odpovídaly odpovědím v produkci.
Příklady kódu
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
}'