Gå till: Biblioteket Du är här: Samverkan och utveckling
Nytt från KB Kontakt
fullskärmsbild

Användning av Libris API:er

Här redovisas de tillgängliga API:er som finns i Libris.

Med Libris API:er kan du integrera med Librisdata från och till din organisations lokala system. Du kan använda API:er för att både söka i, skriva in till och hämta data från Libris. API:erna fungerar via HTTP.

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

Ändringar i API:er kan följas genom att prenumerera Libris versionsinformation.

Autentisering

De flesta API-anropen kräver autentisering. Autentiseringen sker genom Libris loginlänk till annan webbplats som är kopplat till ett personligt konto. Rättighetshanteringen sköts med hjälp av OAuth2lä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.

Det finns två olika nivåer av rättigheter:

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

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 GitHublänk till annan webbplats.

  • API-anropen som används för att läsa, skapa, uppdatera och radera poster returnerar svar i formatet JSON-LD. Anrop för att läsa en post kräver inte autentisering. Anrop för att skapa, uppdatera och radera poster kräver autentisering och angivning av en token.

  • API-anropet /find kan användas för att slå mot den interna Libris-databasen. Svaret returneras i formatet JSON-LD. Frågespråk och sökkoder är samma som i gränssnittet till Libris katalogisering och en närmare beskrivning av dessa hittar du i Libris katalogiseringsgränssnittets sektion Hjälplänk till annan webbplats, öppnas i nytt fönster.

  • InformatAPI-anropet /_findhold  kan användas för att lista beståndsposter som det angivna biblioteket har för en specifik bibliografisk post. Biblioteket anges i form av bibliotekssigel. 

  • API-anropet /_compilemarc kan användas för att ladda ner en komplett bibliografisk post med bestånds- och auktoritetsinformation. Svaret returneras i formatet MARC21. 

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 GitHublä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å GitHublänk till annan webbplats. Läs mer om OAI-PMHlänk till annan webbplats.

4. API:ER MOT LIBRIS WEBBSÖK

  • Xsearch är ett API som gör det möjligt att söka och få ut träfflistor och enskilda poster från Libris webbsök. Svaret returneras i rad olika valfria metadataformat: MARCXML, MODS och JSON. Det finns en begränsning på 200 poster i taget per returnerat svar. Instruktioner för hur poster kan hämtas med Xsearch finns på Libris webbsöks hjälpsidorlänk till annan webbplats.

    BasURL: http://api.libris.kb.se/xsearch

  • Lånestatus används för att visa upp tillgängligheten av biblioteks exemplar i Libris webbsök i realtid. För att Libris ska hämta denna information från de lokala bibliotekssystemen behöver biblioteken sätta upp lösningen för Lånestatus. Det finns två metoder att välja mellan. Föredraget är att använda ett skript som returnerar XML. Det finns dock även ett uppslag mot Z29.50 som metod. Länk administreras i Biblioteksdatabasen. 

    Instruktioner för hantering av LånestatusPDF.

  • ILLER API kan användas för att hämta data om fjärrlån. Metadataformat som stöds är JSON, PDF, XML och Text. Användningen av ILLER API:et kräver autentisering.

    Dokumentation om ILLER APIlänk till annan webbplats, öppnas i nytt fönster (på engelska).

    Documentation about ILL APIlänk till annan webbplats, öppnas i nytt fönster (in English)

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 APIlänk till annan webbplats.

Kontakt
Libris kundservice E-post: libris@kb.se Telefon: 010-709 30 60 Fler kontaktuppgifter inom Libris
Tyck till

Hjälpte den här sidan dig?