Autenticação e Primeiros Passos com a API

Visão Geral

A API da Textualiza permite integrar funcionalidades de OCR, estruturação de textos, geração de conteúdo e gestão de frota diretamente no seu sistema. Para começar, você precisa de uma Chave API (token de autenticação).

Gerando sua Chave API

Passo 1: Acessar o Perfil

No painel, vá em Conta → Perfil.

Passo 2: Gerar o Token

Na seção “Chave API”, clique em “Gerar Token”. Uma caixa de confirmação aparecerá perguntando se deseja criar o token. Confirme.

Passo 3: Copiar a Chave

Após a confirmação, sua chave será exibida na tela. Copie e guarde em local seguro — ela será usada em todas as chamadas à API.

Se precisar gerar uma nova chave, exclua a atual clicando em “Excluir Token” e repita o processo.

Usando a Chave nas Requisições

Inclua sua chave no cabeçalho Authorization de toda requisição:

Authorization: Bearer SUA_CHAVE_DE_API
Content-Type: application/json

Exemplo com cURL

curl -X GET https://textualiza.com.br/api/ocr/ \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json"

Exemplo com Python

import requests

url = "https://textualiza.com.br/api/ocr/"
headers = {
    "Authorization": "Bearer SUA_CHAVE_DE_API",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

Documentação Interativa

A Textualiza disponibiliza dois ambientes de documentação interativa onde você pode explorar todos os endpoints e testar chamadas diretamente no navegador:

• Swagger UI: acesse https://textualiza.com.br/api_documents/
• ReDoc: acesse https://textualiza.com.br/api_v1_docs/

Logs de Uso da API

Todas as chamadas feitas com sua chave são registradas automaticamente. Para consultar o histórico de requisições, acesse Conta → Logs de API no painel. Lá você verá:

• Endpoint chamado
• Método HTTP (GET, POST, etc.)
• Data e hora da chamada
• Código de resposta
• Tempo de execução

Endpoints Disponíveis

Dicas de Segurança

• Nunca compartilhe sua chave API publicamente ou em repositórios de código.
• Use variáveis de ambiente para armazenar a chave no seu sistema.
• Caso suspeite de vazamento, exclua a chave imediatamente e gere uma nova.
• Cada chave está vinculada à sua organização — colaboradores de outras organizações não terão acesso.