Content API v0.6.7
- Implementeres af
- Bibliotekssystemet — API'et kan også implementeres for sig
- Kaldes af
- Tjenester der viser bibliotekets program — hjemmeside, app, skærme
- Profil af Provider API
- 4 af de 59 operationer i Provider API
Content API’et dækker ét område: bibliotekets arrangementer. Et arrangement bærer sine tidspunkter, sin lokation, sine målgrupper, sin pris og den serie det eventuelt indgår i.
Det er fire operationer: arrangementerne (GET /content/event),
arrangementerne i en serie (GET /content/event/series/{seriesId}),
indholdskonfigurationen og versionen.
Sådan integrerer du
Autentificering, base-URL og version-parameteren er de samme som i Provider
API’et, og specifikationen erklærer de samme to scopes som Search API’et,
read og write. Start med Get
(GET /configuration/content) — den fortæller hvilke brugerfladesprog
indholdet findes på.
Forholdet til Provider API
Content API er en profil af Provider API’et: alle fire operationer findes
også dér, med samme operation, metode og sti. Den kan implementeres
selvstændigt, så et system kan stille sit program til rådighed uden resten af
Provider API’et.
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
-
versionThe 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_languageThe 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
-
HttpCode400The list of errors. -
HttpCode401BearerBearer token invalid, missing, or expired. -
HttpCode404Resource not found.