API-integraatio

Täydellinen VoxScriber REST API -dokumentaatio kehittäjille. Opi todennuksesta, tärkeimmistä päätepisteistä, verkkokutsuista ja automaattisen transkription integroinnista järjestelmiisi.

API-ominaisuudet

Todennus

API-avaimen hankkiminen

API-avaimen käyttäminen

Sisällytä API-avaimesi kaikkien pyyntöjen Authorization-otsikkoon:

curl -X POST https://api.vozparatexto.com.br/v1/transcribe \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@audio.mp3"

Päätepisteet

Tiedoston lähetys

POST /v1/upload
Content-Type: multipart/form-data

Parametrit:

• file (pakollinen) - Ääni-/videotiedosto
• language (valinnainen) - Kielen koodi (esim. "en-US")
• engine (valinnainen) - Transkriptiomoottori ("ASSEMBLYAI", "WHISPER", "ELEVENLABS")
• speaker_detection (valinnainen) - Ota käyttöön puhujan tunnistus (totuusarvo)

Vastaus:

{
  "id": "upload_abc123",
  "status": "UPLOADED",
  "duration": 120.5,
  "fileSize": 2048000
}

Aloita transkriptio

POST /v1/transcribe
Content-Type: application/json

Runko:

{
  "uploadId": "upload_abc123",
  "engine": "ASSEMBLYAI",
  "speakerDetection": true,
  "language": "en-US"
}

Tarkista tila

GET /v1/transcription/{id}/status

Vastaus:

{
  "id": "trans_xyz789",
  "status": "COMPLETED",
  "progress": 100,
  "text": "Transcribed text...",
  "duration": 120.5,
  "creditsUsed": 8
}

Lataa tulos

GET /v1/transcription/{id}/export?format=json

Saatavilla olevat formaatit: json, txt, srt, vtt, docx, pdf

Nopeusrajoitukset

| Päätepiste | Raja | Ikkuna | |---|---|---| | Lähetys | 10 pyyntöä | 60 sekuntia | | Transkriptio | 10 pyyntöä | 60 sekuntia | | Kysely | 60 pyyntöä | 60 sekuntia | | Vienti | 30 pyyntöä | 60 sekuntia |

Integraatioesimerkit

Node.js

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const API_KEY = process.env.VOXSCRIBER_API_KEY;
const BASE_URL = 'https://api.vozparatexto.com.br/v1';

async function transcribeFile(filePath) {
  // 1. Upload
  const form = new FormData();
  form.append('file', fs.createReadStream(filePath));

  const upload = await axios.post(`${BASE_URL}/upload`, form, {
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      ...form.getHeaders()
    }
  });

  // 2. Transcribe
  const transcription = await axios.post(`${BASE_URL}/transcribe`, {
    uploadId: upload.data.id,
    engine: 'ASSEMBLYAI',
    speakerDetection: true
  }, {
    headers: { 'Authorization': `Bearer ${API_KEY}` }
  });

  return transcription.data;
}

Python

import requests
import os

API_KEY = os.environ['VOXSCRIBER_API_KEY']
BASE_URL = 'https://api.vozparatexto.com.br/v1'

def transcribe_file(file_path):
    headers = {'Authorization': f'Bearer {API_KEY}'}

    # 1. Upload
    with open(file_path, 'rb') as f:
        upload = requests.post(
            f'{BASE_URL}/upload',
            headers=headers,
            files={'file': f}
        )

    # 2. Transcribe
    transcription = requests.post(
        f'{BASE_URL}/transcribe',
        headers=headers,
        json={
            'uploadId': upload.json()['id'],
            'engine': 'ASSEMBLYAI',
            'speakerDetection': True
        }
    )

    return transcription.json()

Virheenkäsittely

| Koodi | Merkitys | Suositeltu toimenpide | |---|---|---| | 400 | Virheellinen pyyntö | Tarkista parametrit | | 401 | Ei todennettu | Tarkista API-avaimesi | | 403 | Kielletty | Tarkista tunnuksen käyttöoikeudet | | 429 | Nopeusrajoitus ylitetty | Odota ja yritä uudelleen | | 500 | Sisäinen virhe | Yritä uudelleen 30 sekunnin kuluttua |

Turvallisuus

• Käytä HTTPS:ää kaikkiin pyyntöihin
• Tallenna API-avaimet ympäristömuuttujiin
• Vaihda avaimet säännöllisesti
• Käytä vähimmäistason käyttöoikeuksia
• Ota käyttöön allekirjoituksen varmennus verkkokutsuille

Jatka oppimista

• Verkkokutsut & ilmoitukset - Määritä automaattiset takaisinkutsut
• Eräkäsittely - Transkriboi useita tiedostoja API:n kautta
• Työnkulun automaatio - Automatisoi prosesseja API:n avulla