blob: df5bcea1b56781284d4a693aa543291db8b0dfe9 [file] [log] [blame]
Nils Diewalda31a5152015-04-17 21:05:23 +00001% layout 'main', title => 'KorAP: Application Programming Interface';
2
Akron1120a582017-10-17 12:29:16 +02003<h2 id="tutorial-top">Application Programming Interface</h2>
Nils Diewalda31a5152015-04-17 21:05:23 +00004
Akron07d166a2019-07-17 17:21:29 +02005<p>Internally the communication between KorAP components is done using the KoralQuery protocol.
6 The specification for KoralQuery is available on <%= doc_ext_link_to 'GitHub', "http://korap.github.io/Koral" %>.
7 All API endpoints either use KoralQuery or are (more or lest) REST-ful web APIs.</p>
Nils Diewalda31a5152015-04-17 21:05:23 +00008
Akron07d166a2019-07-17 17:21:29 +02009<p>All publicly available API endpoints including their requests and responses are described in the <%= doc_ext_link_to 'GitHub Wiki', "https://github.com/KorAP/Kustvakt/wiki" %> of <%= doc_link_to 'Kustvakt', 'korap', 'kustvakt' %>.</p>