Provider API v0.6.3

Provider API’et er PLAS’ hovedindgang. Implementerer et bibliotekssystem det, kan en tjeneste der taler PLAS, arbejde med biblioteket uden at kende systemet underneden.

Det dækker det et bibliotek gør hver dag: låneren og lånerens samtykker, lån og fornyelser, reservationer, gebyrer og betaling, beholdning og lokationer, udlån og aflevering, søgning i værker og udgivelser, og bibliotekets arrangementer. Hver del har sin egen gruppe i menuen.

Sådan integrerer du

Tre ting skal på plads, i den rækkefølge du møder dem:

1. Base-URL’en. Specifikationen har ingen servers-blok, så adressen er providerens og aftales med den. Regn ikke med at den er den samme fra bibliotek til bibliotek, heller ikke hos samme provider.
2. En token. POST /authentication/oauth2/token med client_id, client_secret og grant_type=client_credentials giver en Bearer-token, som sendes med på kaldene derefter. Kun GetVersion, AuthenticateClient og RevokeToken klarer sig uden.
3. Versionen. Klienten kan sende den version den forventer, i query-parameteren version. Understøtter provideren den ikke, svarer den med fejlkode 600.

Vejen til det første kald, med eksempler, står i Kom i gang.

Forholdet til de andre API’er

Search API og Content API er profiler af Provider API’et: hver af deres operationer findes også her, med samme operationId, metode og sti. De kan implementeres selvstændigt, så et system kan stille søgning eller arrangementer til rådighed uden hele Provider API’et. Implementerer du Provider API’et, har du allerede dem begge.

Vendor API’et går den modsatte vej: det er den flade tjenesten selv stiller til rådighed, så bibliotekssystemet kan sende hændelser og sende låneren tilbage efter et login.