Pular para o conteúdo principal

Pegar dados de arquivos

POST /get_ocr_data_by_file​

Descrição​

Extrai dados financeiros de boletos e cupons fiscais através da análise de QR Codes e códigos de barras presentes no arquivo enviado.

Requisição​

Headers​

  • Content-Type: multipart/form-data

Body da Requisição​

ParâmetroTipoDescriçãoExemploPadrão
access_tokenstringToken de acesso do usuário (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
unit_tokenstringToken de identificação da unidade (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-

Anexos de Arquivos:

  • file: Arquivo principal (PDF ou imagem), apenas um permitido

Respostas​

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso(exemplo de saida de boleto)​

{
  "success": true,
  "message": "OCR data retrieved successfully",
  "data": [
    {
      "data": "00000000000000000000000000000000000000000000",
      "orientation": "UP",
      "parser": {
        "barcode": "00000000000000000000000000000000000000000000",
        "date": "",
        "digitable_line": "00000000000-0 00000000000-0 00000000000-0 00000000000-0",
        "value": 190.77
      },
      "quality": 4,
      "type": "I25"
    }
  ]
}

400 Requisição Inválida​

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado​

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor​

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição​

curl -s -X POST 'https://portal.fipli.pro/api/v1/get_ocr_data_by_file' \
    -F 'metadata={
      "access_token": "<access_token>",
      "unit_token": "<unit_token>"
    };type=application/json' \
    -F 'file=@./<filename>' \
    | jq

Observações Importantes

  • Tipos de arquivo suportados: PDF, imagens (JPG, PNG)

  • Permitido apenas um entre boleto(barcode) ou nota fiscal(access_key)

  • O conteúdo JSON deve ser enviado como parte do formulário (multipart/form-data), dentro de um campo específico chamado 'metadata', e não no corpo bruto da requisição.