Ferramentas de Desenvolvimento

Acelere sua integração com nossas ferramentas e recursos de desenvolvimento. Fornecemos diversas opções para facilitar o trabalho com a API TranscriMed.

Importante: Sobre SDKs

Nota: A TranscriMed não fornece SDKs oficiais. Nossa API REST foi projetada para ser simples e compatível com qualquer linguagem de programação usando bibliotecas HTTP padrão. Os recursos abaixo ajudam você a integrar rapidamente sem a necessidade de SDKs específicos.

Ferramentas Disponíveis

🔧 Coleção Postman

Execute a API da TranscriMed pelo Postman ou pelo newman.

O que a coleção contém

• Pasta Integration key (B2B): o fluxo completo da chave de integração, em ordem, executável de ponta a ponta pelo Collection Runner ou pelo newman. Ela troca e renova a chave, lista os modelos, gera um documento (assíncrono e depois síncrono), consulta o job, busca-o pelo external_reference_id, corrige o documento por texto e o lê de volta. Opcional: correção por voz.
• Scripts que guardam os tokens e os IDs, geram um Idempotency-Key novo para cada envio e consultam o job até ele terminar (com limite, cerca de 6 minutos por padrão).
• Integration key (B2B): error examples: requisições sem credenciais que mostram os formatos de erro.
• Pastas OAuth2 para aplicativos parceiros que agem em nome de um usuário da TranscriMed. A pasta Jobs API (legacy) usa os endpoints /api/v1/jobs, descontinuados.
• Exemplos de resposta dos principais passos B2B.

Como Usar

1. Baixe a coleção, transcrimed-api.postman_collection.json, e um ambiente:

   • Sandbox (https://api.sandbox.transcrimed.com.br): integre e teste aqui, com uma chave do sandbox.
   • Produção (https://api.transcrimed.com.br): uso real.

2. Importe os dois no Postman e selecione o ambiente.

3. Informe sua credencial como current value do ambiente: integration_key (contas de empresa) ou client_id / client_secret (aplicativos parceiros OAuth2). Os arquivos vêm com esses campos vazios; nunca os coloque em controle de versão.

4. Execute a pasta Integration key (B2B) pelo Collection Runner, ou:

   npx newman run transcrimed-api.postman_collection.json \
     -e Sandbox.postman_environment.json \
     --env-var integration_key="$TRANSCRIMED_INTEGRATION_KEY" \
     --folder "Integration key (B2B)"

Cada execução gera dois documentos, que consomem créditos da conta, a partir de uma nota curta inventada. Use apenas dados fictícios no sandbox. Detalhes no README da coleção (em inglês).

📝 Especificações OpenAPI/Swagger

Gere código cliente automaticamente ou explore a API interativamente.

Arquivos Disponíveis

• API de Autenticação: auth-api.yaml
• API de Registros Médicos: medical-records-api.yaml
• API de Jobs: jobs-api.yaml

Gerando Código Cliente

Use ferramentas como OpenAPI Generator para gerar clientes em qualquer linguagem:

# Exemplo: Gerar cliente Python
openapi-generator generate \
  -i https://developers.transcrimed.com.br/api-specs/medical-records-api.yaml \
  -g python \
  -o ./transcrimed-client-python

# Exemplo: Gerar cliente JavaScript
openapi-generator generate \
  -i https://developers.transcrimed.com.br/api-specs/medical-records-api.yaml \
  -g javascript \
  -o ./transcrimed-client-js

# Exemplo: Gerar cliente PHP
openapi-generator generate \
  -i https://developers.transcrimed.com.br/api-specs/medical-records-api.yaml \
  -g php \
  -o ./transcrimed-client-php

🧪 Testador de API Integrado

Teste endpoints diretamente nas páginas de documentação usando o testador embutido:

• No Guia de Testes da API, cada exemplo tem um painel "Testar este endpoint".
• Escolha o ambiente (Local/Produção), cole seu token Bearer e envie a requisição.
• Os resultados são exibidos na própria página, com status e corpo de resposta.

Dica: Prefira o testador embutido para um fluxo contínuo ao lado da documentação.

📚 Exemplos de Código

Implementações de referência em várias linguagens de programação.

JavaScript/Node.js

// Exemplo usando fetch nativo
async function generateMedicalRecord(audioBase64, accessToken) {
  const response = await fetch('https://api.transcrimed.com.br/api/v1/medical-records/generate', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      audio: audioBase64,
      template_id: 'consulta-geral',
      language: 'pt-BR',
      mode: 'async'
    })
  });
  
  return response.json();
}

// Exemplo usando axios
const axios = require('axios');

async function checkJobStatus(jobId, accessToken) {
  const response = await axios.get(
    `https://api.transcrimed.com.br/api/v1/pipeline/jobs/${jobId}`,
    {
      headers: {
        'Authorization': `Bearer ${accessToken}`
      }
    }
  );
  
  return response.data;
}

Python

import requests
import base64

# Exemplo usando requests
def generate_medical_record(audio_path, access_token):
    # Ler e codificar áudio
    with open(audio_path, 'rb') as f:
        audio_base64 = base64.b64encode(f.read()).decode('utf-8')
    
    # Fazer requisição
    response = requests.post(
        'https://api.transcrimed.com.br/api/v1/medical-records/generate',
        headers={
            'Authorization': f'Bearer {access_token}',
            'Content-Type': 'application/json'
        },
        json={
            'audio': audio_base64,
            'template_id': 'consulta-geral',
            'language': 'pt-BR',
            'mode': 'async'
        }
    )
    
    return response.json()

# Exemplo usando httpx (async)
import httpx
import asyncio

async def check_job_status(job_id, access_token):
    async with httpx.AsyncClient() as client:
        response = await client.get(
            f'https://api.transcrimed.com.br/api/v1/pipeline/jobs/{job_id}',
            headers={'Authorization': f'Bearer {access_token}'}
        )
        return response.json()

PHP

<?php
// Exemplo usando cURL
function generateMedicalRecord($audioPath, $accessToken) {
    // Ler e codificar áudio
    $audioContent = file_get_contents($audioPath);
    $audioBase64 = base64_encode($audioContent);
    
    // Preparar dados
    $data = [
        'audio' => $audioBase64,
        'template_id' => 'consulta-geral',
        'language' => 'pt-BR',
        'mode' => 'async'
    ];
    
    // Configurar cURL
    $ch = curl_init('https://api.transcrimed.com.br/api/v1/medical-records/generate');
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Authorization: Bearer ' . $accessToken,
        'Content-Type: application/json'
    ]);
    
    // Executar e retornar
    $response = curl_exec($ch);
    curl_close($ch);
    
    return json_decode($response, true);
}

// Exemplo usando Guzzle
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.transcrimed.com.br']);

$response = $client->post('/api/v1/medical-records/generate', [
    'headers' => [
        'Authorization' => 'Bearer ' . $accessToken,
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'audio' => $audioBase64,
        'template_id' => 'consulta-geral',
        'language' => 'pt-BR',
        'mode' => 'async'
    ]
]);

$result = json_decode($response->getBody(), true);

Go

package main

import (
    "bytes"
    "encoding/base64"
    "encoding/json"
    "io/ioutil"
    "net/http"
)

type GenerateRequest struct {
    Audio      string `json:"audio"`
    TemplateID string `json:"template_id"`
    Language   string `json:"language"`
    Mode       string `json:"mode"`
}

func generateMedicalRecord(audioPath string, accessToken string) (map[string]interface{}, error) {
    // Ler e codificar áudio
    audioData, err := ioutil.ReadFile(audioPath)
    if err != nil {
        return nil, err
    }
    audioBase64 := base64.StdEncoding.EncodeToString(audioData)
    
    // Preparar requisição
    reqData := GenerateRequest{
        Audio:      audioBase64,
        TemplateID: "consulta-geral",
        Language:   "pt-BR",
        Mode:       "async",
    }
    
    jsonData, _ := json.Marshal(reqData)
    
    // Criar requisição HTTP
    req, _ := http.NewRequest(
        "POST",
        "https://api.transcrimed.com.br/api/v1/medical-records/generate",
        bytes.NewBuffer(jsonData),
    )
    
    req.Header.Set("Authorization", "Bearer "+accessToken)
    req.Header.Set("Content-Type", "application/json")
    
    // Executar requisição
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        return nil, err
    }
    defer resp.Body.Close()
    
    // Ler resposta
    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    
    return result, nil
}

📊 Dashboard de Monitoramento

Acompanhe o uso da API e métricas em tempo real.

Recursos

• Estatísticas de uso da API
• Logs de requisições
• Análise de erros
• Métricas de performance
• Relatórios de faturamento

Acessar

Abrir Dashboard

Bibliotecas HTTP Recomendadas

Como não fornecemos SDKs oficiais, recomendamos usar bibliotecas HTTP bem estabelecidas:

JavaScript/Node.js

• Axios - Cliente HTTP baseado em promises
• Fetch API - API nativa do navegador
• Got - Cliente HTTP amigável

Python

• Requests - Biblioteca HTTP simples e elegante
• httpx - Cliente HTTP com suporte async
• aiohttp - Cliente/servidor HTTP assíncrono

PHP

• Guzzle - Cliente HTTP PHP extensível
• cURL - Extensão nativa do PHP

Java

• OkHttp - Cliente HTTP eficiente
• Retrofit - Type-safe HTTP client

Go

• net/http - Biblioteca padrão
• Resty - Cliente HTTP REST simples

C#/.NET

• HttpClient - Cliente HTTP nativo
• RestSharp - Biblioteca REST simples

Ruby

• Faraday - Cliente HTTP flexível
• HTTParty - Cliente HTTP Ruby amigável

Suporte ao Desenvolvedor

Documentação

• Guia de Início Rápido
• Referência da API
• Exemplos de Integração
• Guia de Autenticação

Comunidade

• Fórum de Desenvolvedores
• Stack Overflow Tag
• GitHub Discussions

Suporte Direto

• Email: developers@transcrimed.com.br
• Portal de Suporte: support.transcrimed.com.br

Próximos Passos

1. Explore a API com nossa Coleção Postman
2. Teste endpoints no testador embutido das páginas de documentação
3. Implemente autenticação seguindo nosso Guia OAuth2
4. Configure webhooks para notificações em tempo real
5. Monitore o uso através do Dashboard

---

Precisa de ajuda? Entre em contato com nossa equipe de suporte ao desenvolvedor em developers@transcrimed.com.br