VocalStack Logo

Documentation

Dapatkan Data Pentranskripsian

Dapatkan data dari transkripsi yang menunggu atau selesai

Transkripsi dari Mikrofon atau LiveStream

Tulis semula ucapan langsung dari mikrofon atau aliran langsung

Sesi Transkripsi

Monitor dan urus keadaan transkripsi dengan sesi

Terjemahkan Transkripsi

Terjemah teks yang ditranskripsikan ke bahasa lain

Tulis semula Audio dari URL

Transkrip ucapan dari audio pra-rekod dalam URL ke teks biasa

Permintaan dan Balasan Penukaran

Pilihan permintaan dan respon umum untuk semua operasi transkripsi

Tulis dan Kemukakan Sesi Polyglot

Cipta sesi yang boleh digunakan untuk menyiarkan transkripsi langsung melalui pautan boleh kongsi awam

Token Pengesahihan Sisi Klien

Layari Dokumentasi
Cipta token pengesahan sementara untuk permintaan sisi klien. Implementasikan permintaan API dengan selamat dalam pelayar web tanpa mendedahkan kekunci API anda.
Token pengesahan adalah langkah keselamatan penting dalam persekitaran klien di mana anda memerlukan perkhidmatan API VocalStack. Anda akan memerlukan ini bila melaksanakan permintaan API dalam pelayar web, aplikasi atau sebarang persekitaran awam lain.
Di sisi pelayan kita boleh gunakan SDK untuk menghasilkan token kebenaran. Secara lalai, pilihan untuk token adalah terhad. Anda mungkin ingin mengemas kini ini untuk sesuai dengan keperluan anda:
  • access: Sama ada "baca-sahaja" atau "baca-tulis". Yang pertama membolehkan anda melaksanakan panggilan API yang mengembalikan data. Yang terakhir membolehkan anda juga melaksanakan permintaan API yang termasuk operasi berkaitan transkripsi yang boleh dicaj. Nilai default untuk pilihan ini adalah. "bacasahaja".
  • lifetime_s: Nombor antara 1 dan 120 mewakili hayat token dalam saat. Selepas tempoh ini, token akan luput dan tidak lagi boleh digunakan. Tandakan bahawa ini tidak akan mempengaruhi permintaan asynchronous yang telah mula menggunakan token ini. (Dalam erti kata lain, apabila permintaan asynchronous telah dimulakan, ia akan berjalan sehingga selesai walaupun token telah luput selepas permintaan telah dimulakan. ) Nilai default untuk pilihan ini adalah. 10.
  • one_time: Boolean yang menunjukkan sama ada token API ini bertujuan untuk penggunaan tunggal. Jika benar, bila token ini telah digunakan untuk permintaan API, ia akan luput. Nilai default untuk pilihan ini adalah. benar.
Inilah yang akan kelihatan pada pelayan 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 perlu tetapkan mekanisme untuk menyediakan token API yang dijana pelayan anda kepada klien anda. Ini akan bergantung kepada infrastruktur dan teknologi anda. Pastikan anda melaksanakan amalan keselamatan terbaik. Sebagai contoh, anda tidak patut mencipta titik hujung API yang melayan token API yang dijana kepada permintaan yang tidak disahkan.
Mengambil API VocalStack pada sisi klien memerlukan anda menggunakan authToken setting instead of an apiKey. Sebagai contoh, pertimbangkan dokumentasi untuk [jenis pautan="documentation" id="d23c4ea1-0d15-4af6-b124-805ef2f12066"].
Dalam contoh ini, ganti:
{ 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();
Apabila menjana dan menyediakan token pengesahan sisi klien, ia penting untuk melaksanakan langkah keselamatan ketat untuk mencegah akses tidak dibenarkan ke API anda. Token adalah alat yang kuat untuk mengakses sumber dan perkhidmatan, dan jika mereka tidak dilindungi, mereka boleh digunakan secara salah. Anda mesti pastikan bahawa hanya klien yang dibenarkan boleh meminta dan menggunakan token, dan anda tidak sepatutnya mendedahkan data sensitif seperti kekunci API dalam persekitaran awam. Kegagalan untuk melakukannya boleh menyebabkan pelanggaran data, akses tidak dibenarkan kepada sumber, atau caj tidak diingini untuk perkhidmatan bil.
Untuk membantu melindungi pelaksanaan anda, pertimbangkan amalan terbaik berikut:
  • Jangan pernah paparkan Kekunci API anda pada Sisi Klien: Kekunci API harus sentiasa menjadi rahsia dan disimpan dengan selamat pada pelayan. Menyatakan mereka dalam kod sisi klien (e. g JavaScript, HTML) boleh membawa kepada akses tidak dibenarkan ke API.
  • Gunakan Penjanaan Token Sisi Pelayan Selamat: Sentiasa cipta token pengesahan pada sisi pelayan untuk mencegah pendedahan kunci API dalam kod klien.
  • Permintaan pengesahan untuk token: Pastikan hanya pengguna atau perkhidmatan yang disahkan sah boleh meminta token API dengan memaksa mekanisme pengesahan (e. Encik. , OAuth, pengesahan sesi).
  • Implementasikan HTTPS: Sentiasa berkhidmat token melalui HTTPS untuk melindungi terhadap serangan man-in-the-middle.
  • Elakkan Mempamerkan Token dalam URL: Jangan pernah hantar token dalam parameter pertanyaan URL kerana ia boleh dilog dalam log pelayan atau dipaparkan dalam sejarah pelayar.
  • Hadkan Skop Token: Hadkan token kepada keizinan minimum yang diperlukan, seperti akses baca-sahaja melainkan akses menulis secara eksplisit diperlukan.
  • Tetapkan Kehilangan Token: Gunakan hayat token yang pendek untuk mengurangkan risiko penyalahgunaan token. Cuba hadkan hayat token berdasarkan corak penggunaan dan keperluan keselamatan.
  • Aktifkan Token Guna Sekala: Jika mungkin, gunakan token sekali guna untuk tindakan sensitif khas untuk memastikan mereka tidak boleh digunakan semula.
Scroll Up