Provider API v0.6.6

Provider API-et er hovedinngangen til PLAS. Når et bibliotekssystem implementerer det, kan en tjeneste som snakker PLAS, arbeide med biblioteket uten å kjenne systemet under.

Det dekker det et bibliotek gjør hver dag: låneren og lånerens samtykker, lån og fornyelser, reservasjoner, gebyrer og betaling, beholdning og lokasjoner, utlån og innlevering, søk i verk og utgivelser, og bibliotekets arrangementer. Hver del har sin egen gruppe i menyen.

Slik integrerer du

Tre ting må være på plass, i den rekkefølgen du møter dem:

1. Base-URL-en. Spesifikasjonen har ingen servers-blokk, så adressen er providerens og avtales med den. Ikke regn med at den er den samme fra bibliotek til bibliotek, heller ikke hos samme provider.
2. Et token. POST /authentication/oauth2/token med client_id, client_secret og grant_type=client_credentials gir et Bearer-token, som sendes med på kallene etterpå. Bare GetVersion, AuthenticateClient og RevokeToken klarer seg uten.
3. Versjonen. Klienten kan sende versjonen den forventer, i query-parameteren version. Støtter ikke provideren den, svarer den med feilkode 600.

Veien til det første kallet, med eksempler, står i Kom i gang.

Forholdet til de andre API-ene

Search API og Content API er profiler av Provider API-et: hver av operasjonene deres finnes også her, med samme operationId, metode og sti. De kan implementeres selvstendig, slik at et system kan stille søk eller arrangementer til rådighet uten hele Provider API-et. Implementerer du Provider API-et, har du allerede begge.

Vendor API-et går motsatt vei: det er flaten tjenesten selv stiller til rådighet, slik at bibliotekssystemet kan sende hendelser og sende låneren tilbake etter en innlogging.