VocalStack Logo

Documentation

Dapatkan Data Transkripsi

Dapatkan data dari transkripsi yang menunggu atau selesai

Transkripsi dari Mikrofon atau LiveStream

Transkrip pidato langsung dari mikrofon atau streaming langsung

Transkripsi

Memantau dan mengelola status transkripsi dengan sesi

Terjemahkan sebuah transkripsi

Menerjemahkan teks yang ditranskripsikan ke bahasa lain

Transkripsi Audio dari URL

Transkrip pembicaraan dari audio yang direkam sebelumnya dalam URL ke teks biasa

Permintaan dan Balasan Transkripsi

Opsi permintaan dan respon umum untuk semua operasi transkripsi

Transkripsi dan Presentasi Sesi Polyglot

Membuat sesi yang dapat digunakan untuk menyiarkan transkripsi langsung melalui tautan yang dapat dibagikan secara publik

Token Otentikasi Sisi Klien

Lihat Dokumentasi
Buat token otentikasi sementara untuk permintaan sisi klien. Implementasikan permintaan API dengan aman di peramban web tanpa mengungkapkan kunci API Anda.
Token otentikasi adalah langkah keamanan penting dalam lingkungan klien di mana Anda memerlukan layanan VocalStack API. Anda akan memerlukan ini ketika mengimplementasikan permintaan API di peramban web, aplikasi atau lingkungan publik lainnya.
Di sisi server kita bisa menggunakan SDK untuk menghasilkan token otentikasi. Secara default, pilihan untuk token adalah membatasi. Anda mungkin ingin memperbarui ini untuk sesuai dengan persyaratan Anda:
  • access: "hanya-baca" atau "baca-tulis". Yang pertama memungkinkan Anda untuk melakukan panggilan API yang mengembalikan data. Yang terakhir memungkinkan Anda untuk juga menjalankan permintaan API yang termasuk operasi terkait transkripsi yang dapat dibil. Nilai default untuk opsi ini adalah "hanya baca".
  • lifetime_s: Sebuah angka antara 1 dan 120 mewakili umur token dalam detik. Setelah periode ini, token akan habis dan tidak lagi dapat digunakan. Catat bahwa ini tidak akan mempengaruhi permintaan asynchronous yang sudah dimulai menggunakan token ini. (Dengan kata lain, setelah permintaan asynchronous telah dimulai, ia akan berjalan sampai selesai bahkan jika token telah habis masa berlakunya setelah permintaan telah dimulai. ) Nilai default untuk pilihan ini adalah. 10.
  • one_time: A boolean menandai apakah token API ini dimaksudkan untuk penggunaan tunggal. Jika benar, setelah token ini telah digunakan untuk permintaan API, ia akan habis. Nilai default untuk opsi ini adalah benar.
Inilah yang akan terlihat pada server Anda:
JavaScript
import { Security } from '@vocalstack/js-sdk'; const sdk = new Security({ apiKey: 'YOUR-API-KEY' }); const authToken = await sdk.generateToken({ access: 'readwrite', // Optional: 'readonly' or 'readwrite' lifetime_s: 60, // Optional: 1-120 seconds one_time: true, // Optional: true or false }); // Next, return the token to the client where API request will be made. // Make sure to keep the token secure and do not expose it to the public.
Anda akan perlu untuk menyesuaikan mekanisme untuk melayani server Anda yang dihasilkan token API ke klien Anda. Hal ini akan sangat tergantung pada infrastruktur dan stack teknologi Anda. Pastikan Anda menerapkan praktik keamanan terbaik. Sebagai contoh, Anda tidak harus membuat titik akhir API yang melayani token API yang dihasilkan untuk permintaan yang tidak diotentikasi.
Mengkonsumsi VocalStack API di sisi klien memerlukan Anda untuk menggunakan authToken setting instead of an apiKey. Sebagai contoh, pertimbangkan dokumentasi untuk Transkripsi Audio dari URL.
Dalam contoh ini, ganti saja:
{ apiKey: 'YOUR-API-KEY' } dengan { authToken: 'YOUR-AUTH-TOKEN' } 👇
JavaScript
import { UrlTranscription } from '@vocalstack/js-sdk'; const authToken = await fetch('http://example.com/your-secured-api/authenticate') .then((response) => response.json()) .then((data) => data.token); const sdk = new UrlTranscription({ authToken }); const transcription = await sdk.connect({ url: 'http://example.com/speech.mp3' }); transcription.start();
Ketika menghasilkan dan menyediakan token otentikasi di sisi klien, sangat penting untuk menerapkan langkah-langkah keamanan yang ketat untuk mencegah akses yang tidak sah ke API. Token adalah alat yang kuat untuk mengakses sumber daya dan layanan, dan jika tidak terlindungi, maka dapat disalahgunakan. Anda harus memastikan bahwa hanya klien yang diizinkan yang dapat meminta dan menggunakan token, dan Anda tidak boleh pernah mengungkapkan data sensitif seperti kunci API di lingkungan publik. Kegagalan untuk melakukan hal ini dapat mengakibatkan pelanggaran data, akses yang tidak diizinkan ke sumber daya, atau biaya yang tidak diinginkan untuk layanan yang dapat dibilling.
Untuk membantu mengamankan implementasi Anda, pertimbangkan praktek terbaik berikut ini:
  • Jangan pernah memaparkan kunci API Anda di sisi klien: Kunci API harus selalu tetap rahasia dan disimpan dengan aman di server. Mengungkapkan mereka dalam kode sisi klien (e. Mr. JavaScript, HTML) dapat mengarah pada akses yang tidak diizinkan ke API.
  • Gunakan Generasi Token Sisi Server Aman: Selalu menghasilkan token otentikasi di sisi server untuk mencegah paparan kunci API dalam kode klien.
  • Otentikasi permintaan untuk token: Memastikan bahwa hanya pengguna atau layanan yang telah diverifikasi dapat meminta token API dengan memberlakukan mekanisme otentikasi (e. Mr. , OAuth, validasi sesi).
  • Implementasikan HTTPS: Selalu melayani token di HTTPS untuk melindungi terhadap serangan man-in-the-middle.
  • Hindari memaparkan token dalam URL: Jangan pernah menyerahkan token dalam parameter query URL karena mereka dapat terdaftar dalam log server atau terpapar dalam sejarah browser.
  • Batasi skop token: Batasi token ke izin minimum yang diperlukan, seperti akses hanya-baca kecuali akses menulis secara eksplisit diperlukan.
  • Tetapkan Kehilangan Token: Gunakan token dengan umur yang pendek untuk mengurangi risiko penyalahgunaan token. Bayangkan membatasi umur token berdasarkan pola penggunaan dan kebutuhan keamanan.
  • Aktifkan token penggunaan satu kali: Jika mungkin, gunakan token sekali pakai untuk tindakan yang sangat sensitif untuk memastikan bahwa mereka tidak dapat digunakan kembali.
Scroll Up