Search API v0.6.5

Search API’et er katalogets læseside: otte GET-operationer over værker (work), udgivelser (publication), aktører (agent) og forslag (suggestions), plus den konfiguration der fortæller hvad provideren understøtter.

Fladen er læsende alene. Der er ingen operation der skriver, og det er grunden til at den kan stå for sig: en søgeoplevelse kan bygges én gang og flyttes mellem bibliotekssystemer uden at røre resten af integrationen.

Sådan integrerer du

Autentificering, base-URL og version-parameteren er de samme som i Provider API’et — samme POST /authentication/oauth2/token, samme Bearer-token. Her erklærer specifikationen desuden to scopes, read og write, hvor Provider API’et ingen har.

Start med GET /configuration/search. Den siger hvad provideren faktisk understøtter af felter og operatorer, og det er billigere at læse end at gætte.

Forholdet til Provider API

Search API er en profil af Provider API: alle otte operationer findes også dér, med samme operationId, metode og sti. Forskellen er ikke indholdet, men omfanget — en leverandør kan implementere søgning alene uden at implementere lånere, lån og beholdning.

Bygger du et produkt mod et bibliotekssystem der allerede har hele Provider API’et, kan du kalde operationerne begge steder. Vælg denne reference når det kun er søgning der er i spil; den er kortere at læse.