De REST API van Omeka S is een gestandaardiseerde interface waarmee ontwikkelaars programmatisch toegang kunnen krijgen tot en interactie kunnen hebben met de gegevens in een Omeka S-installatie. De REST API maakt gebruik van HTTP-protocollen en -methoden om gegevens op te halen, toe te voegen, bij te werken en te verwijderen.
Hier is een overzicht van de belangrijkste kenmerken van de Omeka S REST API:
-
Basis-URL: De basis-URL van de Omeka S REST API heeft meestal de volgende structuur:
https://je-omeka-s-domein/api. -
Gegevenstypen: De API biedt toegang tot verschillende gegevenstypen, zoals items, itemsets, media, sites en gebruikers. Om toegang te krijgen tot deze gegevenstypen, voeg je het type toe aan de basis-URL, bijvoorbeeld
https://je-omeka-s-domein/api/items. -
HTTP-methoden: De REST API maakt gebruik van standaard HTTP-methoden om te communiceren met de server, zoals:
- GET: Om gegevens op te halen, zoals het opvragen van een item of een lijst met items.
- POST: Om nieuwe gegevens toe te voegen, zoals het maken van een nieuw item of itemset.
- PUT: Om bestaande gegevens bij te werken, zoals het wijzigen van de metadata van een item.
- DELETE: Om gegevens te verwijderen, zoals het verwijderen van een item of itemset.
-
JSON-formaat: De API maakt gebruik van JSON (JavaScript Object Notation) voor de uitwisseling van gegevens. Verzoeken en antwoorden zijn meestal geformatteerd als JSON-objecten.
-
Paginering: Om grote datasets te beheren, ondersteunt de Omeka S REST API paginering. Je kunt paginanummers en het aantal resultaten per pagina opgeven in de API-verzoeken om de opgehaalde gegevens te beperken.
-
Zoekparameters: Je kunt zoekparameters toevoegen aan API-verzoeken om de opgehaalde gegevens te filteren op basis van specifieke criteria, zoals het zoeken naar items met een bepaalde eigenschap of waarde.
-
Authenticatie: Voor bepaalde acties, zoals het toevoegen, bijwerken of verwijderen van gegevens, is authenticatie vereist. Dit wordt meestal gedaan met behulp van API-sleutels, die door beheerders kunnen worden gegenereerd en aan gebruikers kunnen worden verstrekt.
Wanneer je https://je-omeka-s-domein/api opvraagt worden de beschikbare API resources getoond:
