Skip to main content
POST
Autenticação - FlexExtractor

Visão Geral

A API FlexExtractor utiliza autenticação baseada em username e password para gerar tokens de acesso. Este token deve ser usado em todas as requisições subsequentes para extração de dados.

Autenticação Simples

Username + Password via POST

Token JWT

Retorna access_token e refresh_token

Validade Configurável

Tokens com tempo de expiração definido

Refresh Automático

Renovação via refresh_token

Fluxo de Autenticação

1

Enviar Credenciais

Faça um POST com username e password
2

Receber Token

API retorna access_token e refresh_token
3

Usar Token

Adicione o token no header: Authorization: Bearer {access_token}
4

Renovar se Necessário

Use refresh_token quando o access_token expirar

Request Parameters

Teste Agora! Use o playground interativo “Try It” na lateral direita desta página →Preencha suas credenciais e clique em “Send” para gerar seu token.

Body Parameters (application/x-www-form-urlencoded)

string
required
Identificação do cliente fornecida pela FlexdocFormato: String alfanuméricaExemplo: cliente_teste
string
required
Senha do cliente fornecida pela FlexdocFormato: StringExemplo: SuaSenhaSegura123
Nunca compartilhe ou exponha sua senha em repositórios públicos ou código frontend

Response

string
required
Token JWT para autenticação nas APIs. Use no header Authorization: Bearer {token}Formato: JWT (JSON Web Token)Exemplo: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
integer
Tempo de validade do access_token em segundosExemplo: 3600 (1 hora)
integer
Tempo de validade do refresh_token em segundosExemplo: 86400 (24 horas)
string
Token para renovar o access_token quando expirarUso: Envie em requisição de refresh para obter novo access_token
string
Tipo do token. Sempre retorna Bearer
string
Token de identificação (OpenID Connect)
string
Estado da sessão de autenticação
string
Escopos de acesso concedidos ao tokenExemplo: profile email
integer
Política de tempo mínimo antes do token ser válido

Exemplos de Código


Gerenciamento de Token

O access_token possui tempo de expiração configurável (geralmente 1 hora).Recomendações:
  • Armazene o horário de expiração ao obter o token
  • Renove o token 5 minutos antes de expirar
  • Use o refresh_token para renovação automática
  • Implemente tratamento de erro 401 (token expirado)
Exemplo de gerenciamento:
Boas Práticas:
  • Cache tokens em memória durante validade
  • Use variáveis de ambiente para credenciais
  • Implemente singleton para gerenciamento centralizado
  • Criptografe tokens se armazenar em disco
Evite:
  • Armazenar tokens em localStorage (frontend)
  • Logar tokens completos
  • Compartilhar tokens entre usuários
  • Hard-code de credenciais no código
Exemplo de cache seguro:
Erro 401 - Invalid Credentials
Causa: Username ou password incorretosSolução: Verifique as credenciais fornecidas
Erro 400 - Missing Parameters
Causa: Parâmetros obrigatórios ausentesSolução: Certifique-se de enviar username e password
Erro 401 - Token ExpiredQuando usar um token expirado em outras APIs:Solução: Renove o token usando refresh_token ou obtenha um novo
Práticas de Segurança:
  1. Proteja Credenciais:
    • Nunca commite username/password em Git
    • Use variáveis de ambiente (.env)
    • Rotacione senhas periodicamente
  2. Proteja Tokens:
    • Use apenas HTTPS em produção
    • Nunca envie tokens em URLs
    • Não armazene em cookies sem flags de segurança
  3. Monitoramento:
    • Registre tentativas de autenticação falhas
    • Configure alertas para uso anômalo
    • Implemente rate limiting
  4. Exemplo .env:

Próximos Passos

Após obter seu token de acesso, você está pronto para usar a API de Extração!

Extração de Dados (JSON)

Extraia informações de documentos via imagem Base64

Tipos de Documento

Veja os tipos de documento suportados (RG, CNH, etc)