Development Tools

Accelerate your integration with our development tools and resources. We provide various options to make working with the TranscriMed API easier.

Important: About SDKs

Note: TranscriMed does not provide official SDKs. Our REST API is designed to be simple and compatible with any programming language using standard HTTP libraries. The resources below help you integrate quickly without the need for specific SDKs.

Available Tools

🔧 Postman Collection

Quickly test all API endpoints with our complete Postman collection.

Features

All API endpoints pre-configured
Environment variables for different environments
Pre-request scripts for authentication
Request and response examples
Automated tests included

How to Use

Download Collection transcrimed-api.postman_collection.json

Import to Postman

Open Postman
Click "Import" 
Select downloaded files
Configure your credentials in the environment

Configure Variables

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "api_base_url": "https://api.transcrimed.com.br"
}

📝 OpenAPI/Swagger Specifications

Generate client code automatically or explore the API interactively.

Available Files

Authentication API: auth-api.yaml
Medical Records API: medical-records-api.yaml
Jobs API: jobs-api.yaml

Generating Client Code

Use tools like OpenAPI Generator to generate clients in any language:

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

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

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

🧪 Inline API Tester

Test endpoints directly from the documentation pages using the embedded tester:

On the API Testing Guide, each example has a "Test this endpoint" panel.
Choose the environment (Local/Production), paste your Bearer token, and send the request.
Results are shown inline, with status and response body.

Tip: Prefer the embedded tester for a seamless workflow next to the docs.

📚 Code Examples

Reference implementations in various programming languages.

JavaScript/Node.js

// Example using native fetch
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: 'general-consultation',
      language: 'en',
      mode: 'async'
    })
  });
  
  return response.json();
}

// Example using axios
const axios = require('axios');

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

Python

import requests
import base64

# Example using requests
def generate_medical_record(audio_path, access_token):
    # Read and encode audio
    with open(audio_path, 'rb') as f:
        audio_base64 = base64.b64encode(f.read()).decode('utf-8')
    
    # Make request
    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': 'general-consultation',
            'language': 'en',
            'mode': 'async'
        }
    )
    
    return response.json()

# Example using 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/jobs/{job_id}',
            headers={'Authorization': f'Bearer {access_token}'}
        )
        return response.json()

PHP

<?php
// Example using cURL
function generateMedicalRecord($audioPath, $accessToken) {
    // Read and encode audio
    $audioContent = file_get_contents($audioPath);
    $audioBase64 = base64_encode($audioContent);
    
    // Prepare data
    $data = [
        'audio' => $audioBase64,
        'template_id' => 'general-consultation',
        'language' => 'en',
        'mode' => 'async'
    ];
    
    // Configure 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'
    ]);
    
    // Execute and return
    $response = curl_exec($ch);
    curl_close($ch);
    
    return json_decode($response, true);
}

// Example using 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' => 'general-consultation',
        'language' => 'en',
        '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) {
    // Read and encode audio
    audioData, err := ioutil.ReadFile(audioPath)
    if err != nil {
        return nil, err
    }
    audioBase64 := base64.StdEncoding.EncodeToString(audioData)
    
    // Prepare request
    reqData := GenerateRequest{
        Audio:      audioBase64,
        TemplateID: "general-consultation",
        Language:   "en",
        Mode:       "async",
    }
    
    jsonData, _ := json.Marshal(reqData)
    
    // Create HTTP request
    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")
    
    // Execute request
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        return nil, err
    }
    defer resp.Body.Close()
    
    // Read response
    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    
    return result, nil
}

🔐 Local Test Server

Node.js script for testing webhooks and integrations locally.

Download and Usage

Download Script

curl -O https://api.transcrimed.com.br/tools/transcrimed-api-test-server.js

Run Server

# Basic server
node transcrimed-api-test-server.js

# With HMAC signature verification
WEBHOOK_SECRET=your_secret node transcrimed-api-test-server.js

Server Features
- Receives and logs webhooks
- Verifies HMAC signatures
- Simulates API responses
- Useful for local development

📊 Monitoring Dashboard

Track API usage and real-time metrics.

Features

API usage statistics
Request logs
Error analysis
Performance metrics
Billing reports

Access

Open Dashboard

Recommended HTTP Libraries

Since we don't provide official SDKs, we recommend using well-established HTTP libraries:

JavaScript/Node.js

Axios - Promise-based HTTP client
Fetch API - Native browser API
Got - Human-friendly HTTP client

Python

Requests - Simple and elegant HTTP library
httpx - HTTP client with async support
aiohttp - Asynchronous HTTP client/server

PHP

Guzzle - Extensible PHP HTTP client
cURL - Native PHP extension

Java

OkHttp - Efficient HTTP client
Retrofit - Type-safe HTTP client

Go

net/http - Standard library
Resty - Simple REST client

C#/.NET

HttpClient - Native HTTP client
RestSharp - Simple REST library

Ruby

Faraday - Flexible HTTP client
HTTParty - Ruby-friendly HTTP client

Developer Support

Documentation

Community

Direct Support

Email: developers@transcrimed.com.br
Support Portal: support.transcrimed.com.br

Next Steps

Explore the API with our Postman Collection
Test endpoints in the API Playground
Implement authentication following our OAuth2 Guide
Configure webhooks for real-time notifications
Monitor usage through the Dashboard

Need help? Contact our developer support team at developers@transcrimed.com.br

Important: About SDKs​

Available Tools​

🔧 Postman Collection​

Features​

How to Use​

📝 OpenAPI/Swagger Specifications​

Available Files​

Generating Client Code​

🧪 Inline API Tester​

📚 Code Examples​

JavaScript/Node.js​

Python​

PHP​

Go​

🔐 Local Test Server​

Download and Usage​

📊 Monitoring Dashboard​

Features​

Access​

Recommended HTTP Libraries​

JavaScript/Node.js​

Python​

PHP​

Java​

Go​

C#/.NET​

Ruby​

Developer Support​

Documentation​

Community​

Direct Support​

Next Steps​

Important: About SDKs

Available Tools

🔧 Postman Collection

Features

How to Use

📝 OpenAPI/Swagger Specifications

Available Files

Generating Client Code

🧪 Inline API Tester

📚 Code Examples

JavaScript/Node.js

Python

PHP

Go

🔐 Local Test Server

Download and Usage

📊 Monitoring Dashboard

Features

Access

Recommended HTTP Libraries

JavaScript/Node.js

Python

PHP

Java

Go

C#/.NET

Ruby

Developer Support

Documentation

Community

Direct Support

Next Steps