Pré-requisito: Antes de iniciar, obtenha sua chave de API na plataforma do Scanify.

1

Obtenha o Token de Acesso

Para autenticar e acessar os endpoints do Scanify, você precisa gerar um token de acesso JWT.

curl -X POST https://api.scanify.com.br/auth/token \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "sua-chave-de-api"
  }'

Esse comando retornará um token que deverá ser incluído no cabeçalho das requisições:

{
  "token": "seu-jwt-token",
  "expiresIn": 3600
}

Para mais informações, consulte a documentação do endpoint de autenticação.

2

Envie Documentos para OCR

Depois de autenticado, envie um documento para ser processado pelo OCR. Esse processo converte o conteúdo visual do documento em texto.

curl -X POST https://api.scanify.com.br/ocr/upload \
  -H "Authorization: Bearer seu-jwt-token" \
  -F "file=@caminho/do/seu/arquivo.pdf"

Nota: Verifique se o arquivo atende aos limites de tamanho do seu plano.

3

Consulte o Status do Processamento

Após enviar o documento, você pode verificar o status de processamento usando o jobId retornado ao fazer o upload.

curl -X GET https://api.scanify.com.br/ocr/status/{jobId} \
  -H "Authorization: Bearer seu-jwt-token"

Os possíveis status são processing, completed ou failed.

4

Obtenha o Resultado do OCR

Assim que o processamento estiver concluído, você pode recuperar o texto extraído do documento usando o jobId.

curl -X GET https://api.scanify.com.br/ocr/result/{jobId} \
  -H "Authorization: Bearer seu-jwt-token"

A resposta incluirá o texto extraído:

{
  "jobId": "123456",
  "text": "Conteúdo extraído aqui..."
}

​
Configurações de Webhook (Opcional)

Configure um webhook para receber notificações automáticas ao final do processamento do OCR, evitando a necessidade de consultas repetidas ao status.

Assim que um documento for processado, o Scanify enviará uma notificação POST para o webhook configurado.

​
Resolução de Problemas

Veja como resolver alguns problemas comuns ao utilizar a API do Scanify.