Pular para o conteúdo principal

Guia de Testes da API

Teste as APIs da TranscriMed diretamente do seu navegador usando nossas ferramentas de teste interativas.

Modo de Teste​

A TranscriMed oferece um ambiente de teste integrado que permite testar sua integração de forma segura:

  • Credenciais de Teste: Use Client IDs que começam com test_tc_ para ativar o modo de teste
  • Respostas Simuladas: Receba dados mock realísticos sem processamento real de IA
  • Sem Custos: Teste gratuitamente sem consumir créditos de produção
  • Validação de Dados: Aceita apenas dados de teste específicos para segurança

Pré-requisitos​

Antes de testar as APIs, você precisará de:

  1. Credenciais de API: Obtenha credenciais de teste no Portal do Desenvolvedor
  2. Modo de Teste: Use credenciais de teste para experimentação segura
  3. Dados de Teste: Use nossos dados de exemplo específicos para teste

Documentação Interativa da API​

Explore nossas especificações OpenAPI com ferramentas interativas:

Exemplos de Testes Rápidos​

Testar Autenticação​

Teste o endpoint de validação de token:

Gerar Registro Médico​

Teste a geração de registro médico com texto de exemplo:

Listar Tarefas​

Verifique suas tarefas de processamento:

Melhores Práticas de Teste​

1. Comece com Credenciais de Teste​

Sempre teste com credenciais de teste primeiro:

  • URL Base: https://api.transcrimed.com.br (mesma da produção)
  • Client ID: Começa com test_tc_
  • Client Secret: Começa com test_tcs_
  • Sem custos reais de processamento de dados
  • Seguro para experimentação

2. Use Dados de Teste​

Fornecemos dados de exemplo para testes:

Áudio de Exemplo (Base64)​

UklGRiQAAABXQVZFZm10IBAAAAABAAEARKwAABCxAgAEABAAZGF0YQAAAAA=

Texto Clínico de Exemplo​

Paciente masculino, 52 anos, hipertenso e diabético, em uso regular de 
losartana 50mg e metformina 850mg. Apresenta queixa de cefaleia 
occipital há 2 semanas, de forte intensidade, associada a náuseas.
PA: 160x100 mmHg, FC: 88 bpm, glicemia capilar: 180 mg/dL.

3. Trate Erros Adequadamente​

Cenários de erro comuns para testar:

  • 401 Unauthorized: Chave da API inválida ou ausente
  • 429 Too Many Requests: Limite de taxa excedido
  • 400 Bad Request: Parâmetros de requisição inválidos
  • 500 Internal Server Error: Problemas do servidor

4. Monitore Limites de Taxa​

Verifique os cabeçalhos de resposta para informações sobre limite de taxa:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642262400

Ferramentas de Teste​

Coleção do Postman​

Importe nossa coleção do Postman para testes abrangentes da API:

  1. Baixe: Coleção da API TranscriMed
  2. Importe no Postman
  3. Configure variáveis de ambiente:

Exemplos de cURL​

Teste com cURL da linha de comando:

# Validar token
curl -X GET https://api.transcrimed.com.br/api/oauth/validate \
  -H "Authorization: Bearer SUA_CHAVE_DA_API"

# Gerar registro médico
curl -X POST https://api.transcrimed.com.br/api/v1/medical-records/generate \
  -H "Authorization: Bearer SUA_CHAVE_DA_API" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Paciente com dor torácica",
    "mode": "sync",
    "template_id": "consulta-geral"
  }'

Exemplo em Python​

import requests

# Configurar
API_KEY = "sua_chave_da_api"
BASE_URL = "https://api.transcrimed.com.br"  # Mesmo endpoint para teste e produção

# Fazer requisição
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

response = requests.post(
    f"{BASE_URL}/api/v1/medical-records/generate",
    headers=headers,
    json={
        "text": "Paciente com sintomas gripais",
        "mode": "sync",
        "template_id": "consulta-geral"
    }
)

print(response.json())

Dicas de Depuração​

1. Verifique o Formato da Requisição​

Certifique-se de que suas requisições seguem o formato correto:

  • Cabeçalhos estão configurados adequadamente
  • Corpo JSON é válido
  • Campos obrigatórios estão incluídos

2. Inspecione Cabeçalhos de Resposta​

Os cabeçalhos de resposta contêm informações úteis para depuração:

  • X-Request-Id: Identificador único da requisição para suporte
  • X-Processing-Time: Tempo de processamento do servidor
  • Cabeçalhos de limite de taxa

3. Use IDs de Requisição​

Ao entrar em contato com o suporte, sempre forneça:

  • ID da requisição dos cabeçalhos de resposta
  • Timestamp da requisição
  • Mensagem de erro recebida

Próximos Passos​

Pronto para integrar a TranscriMed em sua aplicação?

  1. Leia o Guia de Primeiros Passos - Integração passo a passo
  2. Explore Autenticação - Implemente o fluxo OAuth2
  3. Confira Exemplos - Exemplos de integração do mundo real
  4. Navegue pelas Ferramentas - Use nossas ferramentas e recursos para desenvolvimento

Suporte​

Precisa de ajuda com os testes?