Vendor API v0.6.7

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

1. Registrer mottakeren. Tjenesten registrerer adressen sin og en hemmelighet med RegisterEventReceiver i Provider API-et. Hemmeligheten må være minst 16 tegn og bør være tilfeldig generert.
2. Sjekk avsenderen. Hendelsesmottakeren er sikret med den hemmeligheten (EventReceiverSecretAuth i spesifikasjonen). Mottakeren svarer 204.
3. Ta imot låneren. Etter en innlogging sendes låneren tilbake med code og state — eller error hvis 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.