Vendor API v0.6.6
- Implementeres av
- Tjenesten — leverandørens egen backend
- Kalles av
- Bibliotekssystemet, når noe har skjedd eller en innlogging skal fullføres
De tre andre API-ene beskriver hva en tjeneste kan kalle hos bibliotekssystemet. Vendor API-et beskriver hva systemet sender til tjenesten — derfor implementerer tjenesten det i stedet for å kalle det.
Det har fire operasjoner. Bibliotekssystemet sender hendelser til
POST /events/receiver, så tjenesten ikke trenger å spørre igjen og igjen. Det
sender lånerens nettleser tilbake til tjenestens callbacks etter en
single sign-on-innlogging eller en registrering (GET /callbacks/patron) og
etter en sletting (GET /callbacks/patron/delete). Og GET /version finnes
som i de andre API-ene.
Slik integrerer du
- Registrer mottakeren. Tjenesten registrerer adressen sin og en
hemmelighet med
Registeri Provider API-et. Hemmeligheten må være minst 16 tegn og bør være tilfeldig generert.Event Receiver - Sjekk avsenderen. Hendelsesmottakeren er sikret med den hemmeligheten
(
Eventi spesifikasjonen). Mottakeren svarerReceiver Secret Auth 204. - Ta imot låneren. Etter en innlogging sendes låneren tilbake med
codeogstate— ellererrorhvis det ikke lyktes. Forløpet står i Kom i gang.
Forholdet til de andre API-ene
Vendor API-et er en inngang på linje med Provider API-et, ikke en
delmengde av det: bare GET /version finnes begge steder. De to er retningene
i det samme samarbeidet — en tjeneste som både henter og mottar, kaller
Provider API-et og implementerer Vendor API-et.
Felles for operasjonene
Disse definisjonene deles av API-ets operasjoner. De er dokumentert ett sted her; en operasjon viser bare det som er dens eget, pluss kodene den kan svare med.
Autentisering
EventReceiverSecretAuth · apiKey
Parametere
-
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.
Feilsvar
-
HttpCode400The list of errors. -
HttpCode401SecretSecret is invalid.