Search API v0.6.7

Vis som Markdown Sidens .md-fil llms.txt Alle sider, til AI-værktøjer Åbn i ChatGPT Stil spørgsmål om siden Åbn i Claude Stil spørgsmål om siden

Katalogets læseside — værker, udgivelser, aktører og forslag.

6 grupper · 8 operationer · 8 stier · 147 skemaer Genereret fra search_v0_6_7.yaml · OpenAPI 3.0.0 Hent OpenAPI-filen

Implementeres af: Bibliotekssystemet — API'et kan også implementeres for sig
Kaldes af: Tjenester der viser kataloget — apps, hjemmesider, selvbetjening
Profil af Provider API: 8 af de 59 operationer i Provider API

Search API’et er katalogets læseside: otte GET-operationer — værker (work), udgivelser (publication), aktører (agent), forslag (suggestions), søgekonfigurationen og versionen.

Ingen af dem skriver, og søgningen kan implementeres selvstændigt, uden lånere, lån og beholdning.

Sådan integrerer du

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

Start med GetSearchConfiguration (GET /configuration/search). Den fortæller hvilke filtre og sorteringer provideren understøtter.

Forholdet til Provider API

Search API er en profil af Provider API’et: alle otte operationer findes også dér, med samme operationId, metode og sti. Forskellen er omfanget — søgningen kan implementeres alene.

Har bibliotekssystemet hele Provider API’et, kalder tjenesten de samme operationer dér. Denne reference er den korte at læse, når det kun er søgning der er i spil.

Fælles for operationerne

Disse definitioner deles af API’ets operationer. De er dokumenteret ét sted her; en operation viser kun det der er dens eget, plus de koder den kan svare med.

Autentificering

BearerAuth · oauth2 · Flow: clientCredentials · Token-URL: /authentication/oauth2/token

Parametre

version i query · Version · valgfri · bruges af 7 af 8 The 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.
ui_language i query · string · valgfri · bruges af 6 af 8 The UI language the provider will return the content in. All ui language codes should be on this list https://www.loc.gov/marc/languages/

Fejlsvar

HttpCode400 Errors · bruges af 7 af 8 The list of errors.
HttpCode401Bearer Intet indhold i svaret. · bruges af 7 af 8 Bearer token invalid, missing, or expired.
HttpCode404 Intet indhold i svaret. · bruges af 6 af 8 Resource not found.