Vendor API v0.6.5

De tre andre API-ene beskriver hva du kan HENTE fra bibliotekssystemet. Dette beskriver hva systemet kan SENDE til deg — og det er derfor du implementerer det, ikke kaller det.

To ting bruker det. Bibliotekssystemet sender events når noe har skjedd, slik at produktet ditt slipper å spørre om og om igjen; og det kaller et callback når en låntaker har logget inn hos biblioteket og skal sendes tilbake til produktet ditt som godkjent.

Slik integrerer du

1. Still endepunktet til rådighet. POST /events/receiver skal ta imot og svare. Adressen er din egen; den avtales med provideren, akkurat som Provider API-ets base-URL avtales den andre veien.
2. Verifiser avsenderen. Kallet bærer en delt hemmelighet i headeren X-OLA-SECRET (EventReceiverSecretAuth i spesifikasjonen). Stemmer den ikke, svar 401 — det er det eneste som skiller bibliotekssystemet fra alle andre som kan nå adressen din.
3. Ta imot versjonen. version sendes som query-parameter på to av de tre operasjonene. Støtter du den ikke, svarer du med feilkode 600 — samme kontrakt som den andre veien, bare med deg som mottaker.

Forholdet til de andre API-ene

Vendor Consumer API er en inngang på linje med Provider API, ikke en delmengde av det: bare GET /version finnes begge steder. De to er retningene i det samme samarbeidet, og et produkt som både leser og mottar, implementerer dette og kaller Provider.