| Nils Diewald | a31a515 | 2015-04-17 21:05:23 +0000 | [diff] [blame] | 1 | % layout 'main', title => 'KorAP: Application Programming Interface'; |
| 2 | |
| Akron | 1120a58 | 2017-10-17 12:29:16 +0200 | [diff] [blame^] | 3 | <h2 id="tutorial-top">Application Programming Interface</h2> |
| Nils Diewald | a31a515 | 2015-04-17 21:05:23 +0000 | [diff] [blame] | 4 | |
| 5 | <p>Internally the communication between the KorAP components is done using the <%= doc_link_to('KoralQuery', 'api', 'koralquery') %> protocol. The following endpoints make use of this protocol or establish additional mechanisms. All described endpoints are (more or lest) REST-ful web APIs.</p> |
| 6 | |
| 7 | <dl> |
| 8 | <dt><%= doc_link_to('Search API', 'api', 'search') %></dt> |
| 9 | <dd>Initiate queries, create virtual collections.</dd> |
| 10 | |
| 11 | <dt><%= doc_link_to('Match API', 'api', 'match') %></dt> |
| 12 | <dd>Retrieve further information like annotations for a certain match.</dd> |
| 13 | |
| 14 | <dt><%= doc_link_to('User API', 'api', 'user') %></dt> |
| 15 | <dd>Log in, log out, and set and retrieve user properties.</dd> |
| 16 | </dl> |