Vendor API v0.6.5

De tre andre API’er beskriver hvad du kan HENTE fra bibliotekssystemet. Dette beskriver hvad systemet kan SENDE til dig — og det er derfor du implementerer det, ikke kalder det.

To ting bruger det. Bibliotekssystemet sender events når noget er sket, så dit produkt ikke behøver at spørge igen og igen; og det kalder et callback når en låner har logget ind hos biblioteket og skal sendes tilbage til dit produkt som godkendt.

Sådan integrerer du

1. Stil endpointet til rådighed. POST /events/receiver skal tage imod og svare. Adressen er din egen; den aftales med provideren, præcis som Provider API’ets base-URL aftales den anden vej.
2. Verificér afsenderen. Kaldet bærer en delt hemmelighed i headeren X-OLA-SECRET (EventReceiverSecretAuth i specifikationen). Matcher den ikke, svar 401 — det er den eneste ting der adskiller bibliotekssystemet fra alle andre der kan nå din adresse.
3. Tag imod versionen. version sendes som query-parameter på to af de tre operationer. Understøtter du den ikke, svarer du med fejlkode 600 — samme kontrakt som den anden vej, bare med dig som modtager.

Forholdet til de andre API’er

Vendor Consumer API er en indgang på linje med Provider API, ikke en delmængde af det: kun GET /version findes begge steder. De to er retningerne i det samme samarbejde, og et produkt der både læser og modtager implementerer dette og kalder Provider.