| % layout 'main', title => 'KorAP: Application Programming Interface'; |
| |
| <h2>Application Programming Interface</h2> |
| |
| <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> |
| |
| <dl> |
| <dt><%= doc_link_to('Search API', 'api', 'search') %></dt> |
| <dd>Initiate queries, create virtual collections.</dd> |
| |
| <dt><%= doc_link_to('Match API', 'api', 'match') %></dt> |
| <dd>Retrieve further information like annotations for a certain match.</dd> |
| |
| <dt><%= doc_link_to('User API', 'api', 'user') %></dt> |
| <dd>Log in, log out, and set and retrieve user properties.</dd> |
| </dl> |