Search API v0.6.7

Vis som Markdown Sidens .md-fil llms.txt Alle sider, for AI-verktøy Åpne i ChatGPT Still spørsmål om siden Åpne i Claude Still spørsmål om siden

Katalogets leseside — verk, utgivelser, aktører og forslag.

6 grupper · 8 operasjoner · 8 stier · 147 skjemaer Generert fra search_v0_6_7.yaml · OpenAPI 3.0.0 Hent OpenAPI-filen

Implementeres av: Bibliotekssystemet — API-et kan også implementeres for seg
Kalles av: Tjenester som viser katalogen — apper, nettsteder, selvbetjening
Profil av Provider API: 8 av de 59 operasjonene i Provider API

Search API-et er katalogens leseside: åtte GET-operasjoner — verk (work), utgivelser (publication), aktører (agent), forslag (suggestions), søkekonfigurasjonen og versjonen.

Ingen av dem skriver, og søket kan implementeres selvstendig, uten lånere, lån og beholdning.

Slik integrerer du

Autentisering, base-URL og version-parameteren er de samme som i Provider API-et — samme token-endepunkt, samme Bearer-token. Her erklærer spesifikasjonen dessuten to scopes, read og write; Provider API-et erklærer ingen.

Start med GetSearchConfiguration (GET /configuration/search). Den forteller hvilke filtre og sorteringer provideren støtter.

Forholdet til Provider API

Search API er en profil av Provider API-et: alle åtte operasjonene finnes også der, med samme operationId, metode og sti. Forskjellen er omfanget — søket kan implementeres alene.

Har bibliotekssystemet hele Provider API-et, kaller tjenesten de samme operasjonene der. Denne referansen er den korte å lese når det bare er søk som er aktuelt.

Felles for operasjonene

Disse definisjonene deles av API-ets operasjoner. De er dokumentert ett sted her; en operasjon viser bare det som er dens eget, pluss kodene den kan svare med.

Autentisering

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

Parametere

version i query · Version · valgfri · brukes av 7 av 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 · brukes av 6 av 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/

Feilsvar

HttpCode400 Errors · brukes av 7 av 8 The list of errors.
HttpCode401Bearer Ikke noe innhold i svaret. · brukes av 7 av 8 Bearer token invalid, missing, or expired.
HttpCode404 Ikke noe innhold i svaret. · brukes av 6 av 8 Resource not found.