VocalStack Logo

Documentation

گرفتن داده‌های رونوشت

داده‌ها را از رونوشت‌های منتظر یا تکمیل شده بدست آورید

رونوشت از یک میکروفون یا LiveStream

رونوشت سخنرانی زنده از یک میکروفون یا جریان زنده

نشستهای رونوشت

نظارت و مدیریت وضعیت رونویسی با جلسات

ترجمه یک رونوشت

ترجمه متن رونوشت شده به زبان دیگر

رونوشت صدا از نشانی وب

رونوشت گفتار از صدای پیش‌ساخته شده در یک URL به متن ساده

درخواست و پاسخ رونوشت

گزینه‌های درخواست و پاسخهای مشترک برای همۀ عملیات رونوشت

رونوشت و ارائه یک نشست چندزبانه

یک جلسه ایجاد کنید که می‌تواند برای پخش یک رونوشت زنده از طریق یک پیوند عمومی قابل اشتراک استفاده شود

نشانکهای احراز هویت سمت کارساز

بررسى مستندات
ایجاد یک نشانه تأیید هویت موقت برای درخواست‌های سمت کارگزار. در این روش، درخواست‌های API را بدون افشای کلیدهای API خود، در مرورگرهای وب پیاده‌سازی کنید.
توکن‌های احراز هویت یک اقدام امنیتی ضروری در محیط‌های مشتری است که شما به خدمات VocalStack API نیاز دارید. این ویژگی در هنگام پیاده‌سازی درخواست‌های API در مرورگرهای وب، برنامه‌های کاربردی یا هر محیط عمومی دیگر مورد نیاز است.
در سمت سرور می‌توانیم از SDK برای تولید یک توکن اثبات هویت استفاده کنیم. به صورت پیش‌فرض، گزینه‌های برای نشانه محدودکننده هستند. ممکن است بخواهید اینها را برای مطابقت با نیازهای خود به روز کنید:
  • access: یا "فقط خواندن" یا "خواندن- نوشتن". اولی به شما اجازه می‌دهد که درخواست‌های API را اجرا کنید که داده‌ها را برمی‌گردانند. این قابلیت همچنین به شما امکان می‌دهد تا درخواست‌های API را اجرا کنید که شامل عملیات مربوط به رونویسی قابل پرداخت است. مقدار پیش‌فرض برای این گزینه : "فقط براي خواندن".
  • lifetime_s: یک عدد بین ۱ و ۱۲۰ که نشان دهنده عمر توکن به ثانیه است. پس از این مدت، نشانه به پایان می‌رسد و دیگر قابل استفاده نیست. توجه داشته باشید که این امر بر درخواست‌های غیر همگام که از قبل با استفاده از این نشانه شروع شده تأثیر نمی‌گذارد. (به عبارت دیگر، هنگامی که یک درخواست غیر همگام آغاز شده، حتی اگر نشانه پس از شروع درخواست به پایان برسد، تا تکمیل اجرا خواهد شد. ) مقدار پیش‌فرض برای این گزینه ) ده.
  • one_time: یک بولی که نشان می‌دهد آیا این نشانه API برای یک استفاده واحد است. اگر true باشد، پس از اینکه این توکن برای درخواست API استفاده شده باشد، به پایان می‌رسد. مقدار پیش‌فرض برای این گزینه : درست.
این چیزی است که در کارساز شما به نظر می‌رسد:
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.
شما نیاز دارید که یک مکانیزم برای ارائه توکن API تولید شده توسط سرور خود به مشتری خود را تنظیم کنید. این امر تا حد زیادی به زیرساخت و تکنولوژی شما بستگی دارد. مطمئن شو که بهترين روش هاي امنيتي رو اجرا ميکني. برای مثال، نباید یک نقطه پایانی API ایجاد کنید که نشانه‌های API تولید شده را به درخواست‌های بدون احراز هویت ارائه دهد.
مصرف API VocalStack در سمت کارگزار نیازمند استفاده از یک. authToken تنظیم به جای. apiKey. برای مثال، مستندات برای رونوشت صدا از نشانی وب را در نظر بگیرید.
در این مثال ، به سادگی جایگزین کنید:
{ apiKey: 'YOUR-API-KEY' } با { 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();
هنگام تولید و ارائه توکن‌های احراز هویت سمت مشتری، اجرای اقدامات امنیتی سخت برای جلوگیری از دسترسی غیرمجاز به API شما حیاتی است.. توکن‌ها ابزارهای قدرتمندی برای دسترسی به منابع و خدمات هستند و اگر محافظت نشوند، می‌توانند سوء استفاده شوند. شما باید اطمینان حاصل کنید که تنها مشتریان مجاز می‌توانند از توکن‌ها استفاده کنند و نباید هیچگاه داده‌های حساس مانند کلیدهای API را در محیط عمومی افشا کنید. عدم انجام این کار می‌تواند منجر به نقض داده‌ها، دسترسی غیرمجاز به منابع، یا هزینه‌های غیرمقصود برای خدمات قابل پرداخت شود.
برای کمک به امنیت پیاده‌سازی خود، بهترین روش‌های زیر را در نظر بگیرید:
  • هرگز کلیدهای API خود را در سمت کارساز آشکار نکنید: کلیدهای API باید همیشه محرمانه باقی بمانند و به صورت امن در سرور ذخیره شوند. در این حالت، کدهای تابعی (e.g. شنبه JavaScript, HTML) می‌تواند منجر به دسترسی غیرمجاز به API شود.
  • استفاده از تولید نشانۀ جانب کارساز امن: همیشه توکن‌های احراز هویت را در سمت سرور تولید کنید تا از افشای کلیدهای API در کد مشتری جلوگیری کنید.
  • درخواستهای احراز هویت برای نشانه‌ها: اطمینان حاصل کنید که تنها کاربران یا خدماتی که هویتشان تأیید شده می‌توانند با اعمال مکانیسم‌های احراز هویت (e. آقای , OAuth, validation session).
  • پیاده‌سازی HTTPS: همیشه نشانه‌ها را در HTTPS ارائه دهید تا در برابر حملات میانجی محافظت شود.
  • اجتناب از نشانه‌های آشکار در نشانیهای وب: هیچ‌گاه توکن‌ها را در پارامترهای درخواست URL منتقل نکنید زیرا ممکن است در Log سرور ثبت شوند یا در تاریخچه مرورگر آشکار شوند.
  • محدود کردن محدوده نشانه: محدود کردن توکن‌ها به حداقل مجوزهای لازم، مانند دسترسی فقط خواندنی، مگر اینکه دسترسی نوشتنی به طور صریح نیاز باشد.
  • تنظیم انقضای نشان: از عمر کوتاه توکن برای کاهش خطر سوء استفاده از توکن استفاده کنید. محدود کردن عمر توکن بر اساس الگوهای استفاده و نیازهای امنیتی را در نظر بگیرید.
  • فعال‌سازی نشانه‌های یکبار مصرف: اگر امکان دارد، از توکن‌های یکبار مصرف برای اعمال حساس استفاده کنید تا مطمئن شوید که نمی‌توان آن‌ها را مجدداً استفاده کرد.
Scroll Up