Technische documentatie

De VIAA API's: use cases en overzicht

Er zijn interfaces en integratiemogelijkheden voorzien in het VIAA-archiefsysteem. We geven in deze sectie een korte introductie. Meer gedetailleerde informatie vind je verder in de documentatie.

Use cases


Op basis van de API's op jouw VIAA-archief kan je een heel aantal toepassingen bouwen, zoals:

  • Een applicatie die lage resolutie copies van de items downloadt voor lokaal gebruik.

  • Een leeszaalapplicatie, waarbij personen in de leeszaal de items kunnen doorzoeken en eventueel bekijken.

  • Een applicatie die gebruikers van jouw website in staat stelt om gearchiveerde items te doorzoeken of bekijken.

  • Een applicatie die metadata van jouw gearchiveerde items opslaat in je lokaal collectiebeheersysteem.

OAI-PMH interface

De OAI-PMH interface is de belangrijkste API op het archief. Via OAI-PMH kan metadata van items of collecties opgevraagd worden en gesynchroniseerd gehouden worden met een ander archief of applicatie.

Het protocol werkt op basis van 'Providers' en 'Harvesters'. Een provider is een applicatie die metadata ter beschikking stelt aan derde applicaties. Een harvester is een gebruiker van deze metadata.

Het VIAA-archief gedraagt zich als OAI-PMH provider en stelt dus metadata ter beschikking. VIAA content partners kunnen applicaties schrijven die deze metadata 'harvesten' en verder verwerken.

Meer gedetailleerde informatie over OAI-PMH implementatie bij VIAA vind je hier.

REST interface

Sommige functies zijn niet beschikbaar via de OAI-PMH interface. Bijvoorbeeld de export van hoge resolutiebestanden, de update van metadata gebeurt via de REST interface. De documentatie van deze interface is op vraag verkrijgbaar.