Provider API v0.6.5

Provider API-et er PLAS’ hovedflate. Implementerer et bibliotekssystem det, kan ethvert produkt som snakker PLAS arbeide med biblioteket uten å kjenne systemet under — og et produkt som er bygget mot ett bibliotek, virker hos det neste.

Flaten dekker det et bibliotek gjør hver dag: låntakeren og samtykkene hennes, lån og fornyelser, reservasjoner, gebyrer og betaling, beholdning og lokasjoner, checkout og checkin, søk i katalogens verk og utgivelser, og arrangementene biblioteket publiserer. Hver del har sin egen gruppe i menyen.

Slik integrerer du

Det er tre ting du må ha på plass, og de står 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. Regn ikke 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å alle andre kall.
3. Versjonen. Send version som query-parameter på hvert kall. Støtter ikke provideren den, får du feilkode 600 — altså en feil du kan handle på, framfor et svar som ser riktig ut.

Det ene kallet som verken krever token eller avtale, er GET /version. Start der: svarer den, er base-URL-en riktig. Hele veien igjennom, med eksempler, står i Kom i gang.

Forholdet til de andre API-ene

Search API og Content API er profiler av denne flaten: hver eneste av operasjonene deres finnes her, med samme operationId, metode og sti. De finnes for at et system skal kunne implementere ett område alene — søk eller arrangementer — uten å implementere hele Provider API-et. Implementerer du Provider, har du allerede begge.

Vendor Consumer API er derimot den motsatte retningen: flaten ditt eget produkt stiller til rådighet, slik at bibliotekssystemet kan sende noe til deg.