🌐 Acesso à Documentação Interativa
A API Rekogface possui documentação automática e interativa. Escolha sua interface preferida:
/docs) para testar os endpoints diretamente no navegador. É a maneira mais rápida de explorar a API!
✨ Recursos Principais
Detecção de Faces
Identifica faces em imagens com alta precisão, extraindo landmarks, pose e qualidade.
Análise Facial
Analisa características faciais detalhadas incluindo orientação, brilho e nitidez.
Indexação
Armazena faces em coleções organizadas para busca rápida e eficiente.
Busca por Similaridade
Encontra faces semelhantes com controle preciso de threshold de confiança.
Alta Performance
Processamento otimizado com modelos FP16 para máxima velocidade.
Seguro
Autenticação via API Token e processamento seguro de dados.
🔐 Autenticação
Todos os endpoints requerem autenticação via header HTTP:
X-API-Token: seu-token-aquiTestando no Swagger UI
- Acesse
/docsno navegador - Clique no botão "Authorize" 🔓 (canto superior direito)
- Cole seu token no campo indicado
- Clique em "Authorize" e depois "Close"
- Agora você pode testar todos os endpoints!
📡 Endpoints Principais
Detecta faces em uma imagem
Analisa uma imagem e retorna todas as faces detectadas com suas características.
Retorna:- BoundingBox (posição da face)
- Landmarks (pontos faciais)
- Pose (orientação da cabeça)
- Quality (brilho e nitidez)
- Confidence (confiança da detecção)
Adiciona uma face à coleção
Indexa uma face a partir de uma URL para posterior busca por similaridade.
Parâmetros:collection_id- ID da coleçãoexternal_id- ID externo (seu identificador)image_url- URL pública da imagem
Busca faces similares
Encontra faces semelhantes a uma imagem de referência em uma coleção indexada.
Parâmetros:collection_id- ID da coleção onde buscarimage_url- URL da imagem de referênciamax_faces- Máximo de resultados (padrão: 10)face_match_threshold- Limiar 0-100 (padrão: 80)
Verifica status da API
Endpoint simples para verificar se a API está operacional.
💻 Exemplo Prático
Detectar Faces com cURL
curl -X POST "https://seu-dominio.com/v1/recognition/detectFaces" \
-H "X-API-Token: seu-token-aqui" \
-H "Content-Type: multipart/form-data" \
-F "file=@foto.jpg"Adicionar Face com Python
import requests
url = "https://seu-dominio.com/v1/recognition/addFace"
headers = {"X-API-Token": "seu-token-aqui"}
payload = {
"collection_id": "funcionarios",
"external_id": "func_12345",
"image_url": "https://exemplo.com/foto.jpg"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())Buscar Faces com JavaScript
const response = await fetch('https://seu-dominio.com/v1/recognition/searchFacesByImage', {
method: 'POST',
headers: {
'X-API-Token': 'seu-token-aqui',
'Content-Type': 'application/json'
},
body: JSON.stringify({
collection_id: 'funcionarios',
image_url: 'https://exemplo.com/buscar.jpg',
max_faces: 5,
face_match_threshold: 85
})
});
const data = await response.json();
console.log(data);📊 Limites e Especificações
- Tamanho máximo de imagem: 10MB
- Formatos aceitos: JPEG, PNG, WebP
- Timeout: 30 segundos por requisição
- Rate Limit: Conforme seu plano
- Faces por indexação: Exatamente 1 face por imagem
- Faces por busca: Exatamente 1 face de referência
⚠️ Códigos de Resposta HTTP
Requisição processada com sucesso
Erro de validação (imagem inválida, múltiplas faces, etc)
Token de API inválido ou ausente
Recurso não encontrado (ex: URL de imagem inválida)
Erro interno no servidor
🛠️ Ferramentas Recomendadas
Postman / Insomnia
Importe a especificação OpenAPI automaticamente:
https://seu-dominio.com/openapi.jsonGerar SDK Automaticamente
Use o OpenAPI Generator para criar SDKs em diversas linguagens:
# Python
openapi-generator-cli generate -i https://seu-dominio.com/openapi.json -g python -o ./sdk
# JavaScript/TypeScript
openapi-generator-cli generate -i https://seu-dominio.com/openapi.json -g typescript-fetch -o ./sdk