VocalStack Logo

Documentation

Транскрипция деректерді алу

Тексерудегі немесе аяқталған транскрипциялардан деректерді алу

Микрофон немесе LiveStream- дан транскрипциялауName

Тікелей микрофоннан немесе тікелей эфирден сөйлеу транскрипциясын жасау

Транскрипция сеанстары

Транскрипция күйін сеанс арқылы бақылау және басқару

Аударма

Транскрипцияланған мәтіннің басқа тілге аударылуы

Аудио URL- інен аудару

URL-де алдын ала жазылған дыбыстарды жай мәтінге аудару

Транскрипция сұрауы мен жауап

Барлық аудару әрекеттер үшін ортақ сұраныс параметрлері мен жауаптары

Полиглот сеансын транскрипциялап және таныстыруName

Ашық ортақ сілтеме арқылы тікелей транскрипцияны таратуға арналған сеанс құру

Клиент тарапының аутентификация токендері

Құжаттаманы қарау
Клиент тарапынан сұраныс үшін уақытша аутентификация токені жасау. API сұраныстарын веб шолғыштарда API кілттеріңізді жарияламастан қауіпсіз орындау.
Аутентификациялық токендер - бұл VocalStack API қызметтерін қажет ететін клиенттік ортада қауіпсіздікті қамтамасыз етудің маңызды шарасы. Веб шолғыштарда, қолданбаларда немесе басқа ашық орталарда API сұраныстарын орындағанда бұл қажет болады.
Сервер жағынан біз SDK-ны аутентификациялық токенді жасау үшін пайдалана аламыз. Әдетте, токеннің параметрлері шектеулі. Сіздің талаптарыңызға сай мыналарды жаңартқыңыз келуі мүмкін:
  • access: "тек оқу" не "жазу" болсын. Алғашқысы деректерді қайтаратын API шақыруларын орындауға мүмкіндік береді. Соңғысы сізге төлемді транскрипцияға байланысты операцияларды қамтитын API сұраныстарын орындауға мүмкіндік береді. Бұл параметрдің әдетті мәні: "тек оқу".
  • lifetime_s: 1 мен 120 аралығындағы сан, секундта жетонның өмір сүру мерзімі. Осы уақыт өткен соң, токеннің мерзімі аяқталады және одан әрі қолданылмайды. Бұл осы жетонмен басталған асинхронды сұраныстарға әсер етпейтінін ескеріңіз. (Мысалы, асинхронды сұраныс басталғаннан кейін, егер сұраныс басталғаннан кейін жетонның мерзімі аяқталған болса да, ол аяқталуға дейін орындалады. ) Бұл параметрдің әдетті мәні - 10- ші.
  • 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 аяқтау нүктесін құрмау керек.
Клиент тарапынан VocalStack API- ны пайдалану үшін. authToken орнына орнату apiKey. Мысалы, дегеннің құжаттамасын қарастырыңыз.
Мысалы, мынаны алмастыру керек:
{ apiKey: 'YOUR-API-KEY' } көмегімен { authToken: 'YOUR-AUTH-TOKEN' } 6-б.
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 кілттері әрқашан құпия болып, серверде қауіпсіз сақталуы керек. Клиент-сервер арасындағы байланыс (Client-server connection). ж. JavaScript, HTML) API-ге рұқсатсыз қол жеткізуге әкеледі.
  • Сервер жақтағы қауіпсіз токендер құрылсын: Әрқашан сервер жағынан аутентификация токендерін клиент кодында API кілттерімен бөлісуден сақтану үшін шығару.
  • Аутентификациялау сұраныстары: Тек аутентификацияланған пайдаланушылар немесе қызметтер ғана API токенін сұрай алады, бұл үшін аутентификация механизмдерін қолдану керек (e.g. % 1- ге жіберу , OAuth, сеанс тексеру).
  • HTTPS- ті іске асыру: HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті HTTPS-ті.
  • URL- лерде & жетондарды көрсетуден аулақ болу: URL сұраныс параметрлерінде еш уақытта токендерді беру керек емес, себебі олар сервер журналына немесе шолғыш журналына жазылады.
  • Токен аумағы шектелсін: Токендерді минималды қажетті рұқсаттармен шектеу, мысалы, жазуға рұқсат қажет болған жағдайда тек оқуға рұқсат беру.
  • Токеннің мерзімі: Токендерді қысқа мерзімге пайдалану арқылы оларды заңсыз пайдалану қаупін азайту. Қолданбаның функционалдық мүмкіндіктері мен қауіпсіздік талаптарына сәйкес токендер өмірін шектеу керек.
  • Бір реттік жетондар рұқсат етілсін: Мүмкін болса, аса сезімтал әрекеттер үшін бір реттік токендерді қолданыңыз, оларды қайта пайдалануға болмайды.
Scroll Up