Användarvillkor för Libris publika API:er

Libris som dataplattform omfattar ett antal publikt tillgängliga API:er. De flesta av dessa API:er ger lästillgång till öppna, allmänt tillgängliga data. Vissa API:er ger också skrivrättigheter och kräver därmed autentisering och överenskommelse med KB för användning.

Observera att Libris API:er inte är versionerade. Detta innebär att anrop och svar kan komma att ändras i framtiden.

Följ ändringar i API:er

Du kan följa ändringar i API:er genom Libris versionsinformation Länk till annan webbplats..

Tillgänglighet och begränsningar

I allmänhet är API:erna tillgängliga dygnet runt, men KB levererar tjänsten efter bästa förmåga, med andra ord utan garantier. API:ernas tillgänglighet beror även på tillgänglig server- och nätverkskapacitet. Eventuella servicefönster delas via notifieringsfunktionen i Libris katalogiseringsgränssnitt, eller vid större avbrott på kb.se och i andra kanaler.

Kungliga biblioteket kan vid behov sätta mängdbegränsning rörande antalet anrop till API:er (Rate Limiting Länk till annan webbplats.). Om en enskild API-användare utnyttjar tillgängliga resurser i sådan utsträckning att det försämrar tillgängligheten till Kungliga bibliotekets tjänster för andra användare har Kungliga biblioteket möjligheten att blockera den klienten tills vidare, medan en utredning och dialog om nyttjandet pågår.

Autentisering och auktorisering

Läs-API:er

Libris publika API:er kräver ingen autentisering eller API-nyckel.

Skriv-API:er

API:er som ger skrivtillgång kräver autentisering. Autentiseringen sker genom Libris login Länk till annan webbplats. som är kopplat till ett personligt konto. Rättighetshanteringen sköts med hjälp av OAuth2 Länk till annan webbplats.. För att registrera en OAuth2-klient i Libris kontakta Libris kundservice.

Efter autentiseringen får användaren en så kallad token som ska följa med som en parameter för alla anrop som kräver autentisering. Om ett sådant anrop besvaras med ”401 Unauthorized“ så innebär det att rättigheter för att utföra uppgiften saknas eller är ogiltiga.

För att skriva data till Libris finns två olika nivåer av rättigheter:

Nivå 1 för hantering av enbart beståndposter.

Nivå 2 för hantering av både bibliografiska poster och beståndsposter.

Regelverk

• För att använda Libris skriv-API:er krävs att man innehar ett API-konto till Libris för att kunna generera en nyckel (token) vid användning.
• Då nyttjande upphör ska detta meddelas KB som inaktiverar API-kontot.
• Vid missbruk eller upprepad felanvändning förbehåller sig KB rätten att utan dröjsmål dra tillbaka behörighet för API-klienten.
• Alla typer av mängdändringar av data i Libris (inklusive skapande av nya poster och borttagande av poster) via API:er får endast utföras i samråd eller efter överenskommelse med KB och ska köras i testmiljö före implementation.
• Mängdändringar av poster i Libris får endast utföras på det egna beståndet om inte annat är överenskommet med Kungliga biblioteket. En systemleverantör, medieleverantör eller leverantör av katalogiseringstjänst kan utföra sådana mängdändringar på uppdrag av ett Librisanslutet biblioteket.

1. API:er för läsa, skriva och söka

Libris API:er kan användas för att söka, läsa, skapa, uppdatera, hämta och radera poster via HTTP. Instruktioner för hur man använder API:erna finns dokumenterade på Libris XL GitHub Länk till annan webbplats..

2. API för export i MARC21

API för att hämta poster i MARC21-format. Detta API motsvarar batchexport och använder samma sorts exportprofil. Skillnaden är att genom att använda API:et kan hämtningarna göras i önskade intervall. Instruktioner för hur poster kan hämtas med detta API finns på Libris XL GitHub Länk till annan webbplats..

3. OAI-PMH

Genom att använda API-anrop mot OAI-PMH-server går det att hämta enstaka poster samt hela dataset som nationalbibliografin och svenska ämnesord, i olika format. Teknisk dokumentation på svenska finns i sin helhet på GitHub Länk till annan webbplats.. Läs mer om OAI-PMH Länk till annan webbplats..

4. API:er mot Libris webbsök

5. Biblioteksdatabasens API

Genom att använda ett API kan du hämta information om ett enskilt bibliotek eller listningar på samtliga bibliotek i Biblioteksdatabasen.

Instruktioner för användning av Biblioteksdatabasens API Länk till annan webbplats..