Vendor API v0.6.7
- Implementeres af
- Tjenesten — leverandørens egen backend
- Kaldes af
- Bibliotekssystemet, når noget er sket eller et login skal afsluttes
De tre andre API’er beskriver hvad en tjeneste kan kalde hos bibliotekssystemet. Vendor API’et beskriver hvad systemet sender til tjenesten — derfor implementerer tjenesten det i stedet for at kalde det.
Det har fire operationer. Bibliotekssystemet sender hændelser til
POST /events/receiver, så tjenesten ikke behøver at spørge igen og igen. Det
sender lånerens browser tilbage til tjenestens callbacks efter et single
sign-on-login eller en registrering (GET /callbacks/patron) og efter en
sletning (GET /callbacks/patron/delete). Og GET /version findes som i de
andre API’er.
Sådan integrerer du
- Registrér modtageren. Tjenesten registrerer sin adresse og en
hemmelighed med
Registeri Provider API’et. Hemmeligheden skal være mindst 16 tegn og bør være tilfældigt genereret.Event Receiver - Tjek afsenderen. Hændelsesmodtageren er sikret med den hemmelighed
(
Eventi specifikationen). Modtageren svarerReceiver Secret Auth 204. - Tag imod låneren. Efter et login sendes låneren tilbage med
codeogstate— ellererror, hvis det ikke lykkedes. Forløbet står i Kom i gang.
Forholdet til de andre API’er
Vendor API’et er en indgang på linje med Provider API’et, ikke en
delmængde af det: kun GET /version findes begge steder. De to er retningerne
i samme samarbejde — en tjeneste der både henter og modtager, kalder Provider
API’et og implementerer Vendor API’et.
Fælles for operationerne
Disse definitioner deles af API’ets operationer. De er dokumenteret ét sted her; en operation viser kun det der er dens eget, plus de koder den kan svare med.
Autentificering
EventReceiverSecretAuth · apiKey
Parametre
-
versionThe version of Open Library the vendor expects to receive, if this version isn't supported by the provider an error code 600 (Unsupported Open Library API version) is returned.
Fejlsvar
-
HttpCode400The list of errors. -
HttpCode401SecretSecret is invalid.