Introdução API
A tecnologia de Inteligência Artificial especializada em detecção de falsificação de imagens foi facilitada mais do que nunca usando a API ImgAuth.com. Com apenas algumas linhas de código, você pode trazer esta tecnologia para sua aplicação.
- Parâmetros de Solicitação
- Dados de imagem codificados em Base64 e depois codificados para URL. Máximo de 10 MB. Lado menor com pelo menos 512 px e lado maior com no máximo 8192 px. Suporta jpg/jpeg/png/bmp. Envie image ou url.
- Parâmetros de resposta
- Referência dos campos de resposta da API
Introdução API
- equipes financeiras revisando faturas e recibos
- RH revisando certificados e registros digitalizados
- seguradoras revisando documentos de sinistro
Autenticação
Substitua {your-api-domain} pelo endpoint de API mostrado no painel da sua conta.
Autentique solicitações com o endpoint da API da sua conta e um token Bearer. Após comprar créditos de API, você pode ver seu endpoint e token no painel da conta. Mantenha seu token em segredo e nunca o envie para repositórios públicos.
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
Parâmetros de Solicitação
| Parâmetro | Tipo | ✓ | Descrição |
|---|---|---|---|
| image | string | ✓ | Dados de imagem codificados em Base64 e depois codificados para URL. Máximo de 10 MB. Lado menor com pelo menos 512 px e lado maior com no máximo 8192 px. Suporta jpg/jpeg/png/bmp. Envie image ou url. |
| detect_proportion | boolean | — | Define se a pontuação de confiança da adulteração deve ser retornada. Padrão: false. true retorna a pontuação; false não retorna. |
| return_heatmap | boolean | — | Define se um heatmap de falsificação deve ser retornado. Padrão: false. true retorna um heatmap em Base64; false não retorna. |
| location | boolean | — | Use estes exemplos para construir e depurar sua integração |
Exemplo de Solicitação HTTP
{
"image": "<BASE64_IMAGE_WITHOUT_PREFIX>",
"detect_proportion": true,
"return_heatmap": true,
"location": true
}Parâmetros de resposta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| code | integer | Referência para códigos de resposta API |
| request_id | string | Use estes exemplos para construir e depurar sua integração |
| data.detection_result | "fake" | "real" | Resultado da adulteração: "fake" significa adulteração detectada e "real" significa nenhuma adulteração detectada. |
| data.tampered_proportion | number | null | Pontuação de confiança da adulteração, retornada quando detect_proportion = true. |
| data.heatmap | string | null | Heatmap Base64 das regiões adulteradas, retornado quando return_heatmap = true. |
| data.tampered_location | array | Array com coordenadas de regiões suspeitas, retornado quando probability é maior ou igual a restrict_probability. Cada item inclui left, top, width, height e probability. |
Exemplos de Resposta
{
"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 }
]
}
}Códigos de Erro
400INVALID_REQUESTOs API messages são exibidos com os valores brutos do serviço upstream para corresponder exatamente às respostas de produção.
401INVALID_API_KEYOs API messages são exibidos com os valores brutos do serviço upstream para corresponder exatamente às respostas de produção.
402CREDITS_EXHAUSTEDOs API messages são exibidos com os valores brutos do serviço upstream para corresponder exatamente às respostas de produção.
403API_KEY_INACTIVE / API_KEY_EXPIREDOs API messages são exibidos com os valores brutos do serviço upstream para corresponder exatamente às respostas de produção.
413PAYLOAD_TOO_LARGEOs API messages são exibidos com os valores brutos do serviço upstream para corresponder exatamente às respostas de produção.
415UNSUPPORTED_IMAGEOs API messages são exibidos com os valores brutos do serviço upstream para corresponder exatamente às respostas de produção.
502UPSTREAM_ERROROs API messages são exibidos com os valores brutos do serviço upstream para corresponder exatamente às respostas de produção.
504UPSTREAM_TIMEOUTOs API messages são exibidos com os valores brutos do serviço upstream para corresponder exatamente às respostas de produção.
Exemplos de Código
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
}'