Сэрвіс «Генератар транскрыпцый праз API» прызначаны для графічнага запісу гучання слоў, але яго асаблівасцю з’яўляецца праца праз API, што дае магчымасць выкарыстоўваць сэрвіс у знешніх праграмных прадуктах. У дадзеным апісанні будзе нададзена ўвага менавіта апошняй асаблівасці. Алгарытм генерацыі транскрыпцый і яго функцыянал падрабязней апісаны ў даведцы да сэрвіса «Генератар транкрыпцый».

Асноўныя тэрміны і паняцці

API (праграмны інтэрфейс прыкладнога праграмавання) (англ. application programming interface) — набор гатовых класаў, працэдур, функцый, структур і канстант, якія дае дадатак (бібліятэка, сэрвіс) або аперацыйная сістэма для выкарыстання ў знешніх праграмных прадуктах. Гэта сродак інтэграцыі праграм. API вызначае функцыянальнасць, якую дае праграма (модуль, бібліятэка), пры гэтым API дазваляе абстрагавацца ад таго, як менавіта гэтая функцыянальнасць рэалізаваная.

Мадэль, алгарытм

Каб атрымаць транскрыпцыю адвольнага слова беларускай мовы, патрэбна адправіць AJAX-запыт тыпу POST на адрас http://corpus.by/TranscriptionGenerator/api.php. Праз масіў параметраў data перадаецца тэкст, які патрэбна затранскрыбаваць (параметр text) і мэтавыя фарматы транскрыпцый (параметры tts, cyr, ipa, lat, xsampa). Каб атрымаць транскрыпцыю ў пэўным фармаце, трэба надаць адпаведнаму параметру значэнне «1», у адваротным выпадку — значэнне «0».

Прыклад AJAX-запыту:

$.ajax({
  type: “POST”,
  url: “http://corpus.by/TranscriptionGenerator/api.php”,
  data:{
    “text”: “арфаэпія”,
    “tts”: 0,
    “cyr”: 1,
    “ipa”: 1,
    “lat”: 0,
    “xsampa”: 0
  }
  success: function(msg){  }
});

Сервер верне JSON-масіў з уваходным тэкстам і выніковымі транскрыпцыямі. Напрыклад, па вышэй прыведзеным AJAX-запыце будзе сфарміраваны наступны адказ:

[
  {
    “text”: “арфаэпія”,
    “cyr”: “[арфаэ́п’ійа]”,
    “ipa”: “[arfaˈɛpʲija]”
  }
]

Элементы масіву маюць наступныя палі:

text — уваходны тэкст, перададзены ў AJAX-запыце карыстальнікам;
tts — транскрыпцыя ў фармаце сінтэзатара маўлення;
cyr — транскрыпцыя ў нацыянальным фармаце;
ipa — транскрыпцыя ў фармаце Міжнароднага фанетычнага алфавіту;
lat — транскрыпцыя ў фармаце Спрошчанага міжнароднага фанетычнага алфавіту;
xsampa — транскрыпцыя ў фармаце Пашыранага фанетычнага алфавіту метадаў ацэнкі маўлення.

Заўвага: выніковы масіў мае толькі адно абавязковае поле: text. Усе астатнія палі з’яўляюцца апцыянальнымі і будуць адлюстраваны ў выніковым масіве, толькі калі былі запатрабаваныя.

Спасылкі на крыніцы

Прыклад выкарыстання дадзенага API – інтэрнэт-сэрвіс «Генератар транскрыпцый праз API».