API

1177 Vårdguidens API är en syndikeringstjänst för att kunna återanvända de texter som presenteras på 1177.se på en annan webbplats. Tillsammans med texterna finns även den kategorisering som används på webbplatsen. För att få åtkomst till tjänsten krävs en nyckel som du kan beställa genom att kontakta 1177 Vårdguiden.

API-åtkomst

För att komma åt vårt API som konsument måste man ha en nyckel.

Denna nyckel kan man antingen skicka med i varje anrop som en queryparameter med namnet key eller som en http-header med namnet x-key.

Ett exempel på ett anrop med nyckeln i querysträngen är:

http://www.1177.se/api/v2/artiklar/?key=1234567890abcd

Om nyckeln är felaktig eller inaktiverad får man tillbaka en felsida med HTTP statuskoden 403 Forbidden. 

Kontakta 1177.se för att få en nyckel och därmed tillgång till API:et.

URL-struktur

API:et är byggt på formatet Atom utifrån ett RESTfull arkitekturtänk. Startpunkten för API:et är:

http://www.1177.se/api/v2/artiklar/

När man anropar ovanstående URL får man tillbaka en feed i atom-format.

Det går också att få regionaliserade artiklar genom att anropa flödet med regionsnamnet i adressen, t.ex.:

http://www.1177.se/api/v2/Vastra-Gotaland/artiklar/

I det här fallet får returneras alla artiklar plus alla regionala tillägg från Västra Götaland (om det finns några).

Grundflödet listar de 100 senast uppdaterade artiklarna. Man kan navigera till fler sidor genom att följa navigationslänkarna som finns i Atom-feeden.

Länken med rel="next" attributet pekar på nästa sida

<link rel="next" href="http://www.1177.se/api/v2/artiklar?sida=2&antal=100"/>

Länken med rel="first" attributet pekar på första sidan

<link rel="first" href="http://www.1177.se/api/v2/artiklar?antal=100"/>

Länken med rel="last" attributet pekar på sista sidan

<link rel="last" href="http://www.1177.se/api/v2/artiklar?sida=11&antal=100"/>

Man kan också ange antal (batchsize) som en queryparameter för att kontrollera hur många artiklar man vill hämta åt gången.

http://www.1177.se/api/v2/artiklar?antal=5
http://www.1177.se/api/v2/artiklar?antal=10
http://www.1177.se/api/v2/artiklar?antal=100

Flödet är sorterat på datum för senaste uppdateringen av texten, den artikeln som senast uppdaterades kommer först. För att få fram alla artiklar uppdaterade efter ett visst datum kan man gå genom flödet fram till dess att en artikel, som är uppdaterad tidigare, dyker upp.

Strukturen för en individuell artikel

Varje artikel har ett atom-entry i flödet, som innehåller hela artikelinnehållet i htmlformat. Man når denna artikel genom att följa länken med rel=self i entryt.

<link rel="self" href="http://www.1177.se/api/v2/artiklar/28558"/>

I det här fallet hämtas innehållet för en artikel om astma i atom-format.

Varje artikel har ett unikt ID som aldrig ändras.

<id>urn:uuid:d7ba931a-17f4-45c2-bf25-404467504b0d</id>

Varje artikel-entry innehåller också följande attribut:

  • title - Artikelns titel
  • summary - Artikelns översikt i htmlformat
  • published - Publiceringsdatum
  • updated - Senaste ändringsdatum
  • author - Artikelns skribent
  • contributor - En eller flera artikelgranskare
  • link - Flera länkar med olika attribut
    • title="(länktext)" - Länktexten till länken
    • rel="alternate" - Länk till den riktiga artikeln på 1177.se
    • rel="http://1177.se/api/internallink" - En eller flera länkar till relaterade artiklar på 1177.se
    • rel="http://1177.se/api/externallink" - En eller flera länkar till relaterade artiklar på andra webbplatser
    • rel="self" - Länken som pekar på artikeln själv i API:et
    • type="text/html" länken pekar på en HTML-sida
    • type="application/atom+xml" länken pekar på Atom-representationen för sidan, d.v.s. länken är en API-länk till sidans innehåll. Klienten måste själv lägga till API-nyckeln för att kunna hämta sidan. (Förekommer endast för interna länkar, d.v.s. länkar med rel="http://1177.se/api/internallink")
  • content - Själva artikelinnehållet i htmlformat

Publech-id kan nås genom taggen publechid.

<publechid xmlns="http://1177.se/api/ext/">39743</publechid>

Kategorier

Det finns tre typer av kategorier på artiklar. Den första typen är kategorierna som listas i menyn på webbplatsen, t.ex. "Allergier och överkänslighet" och "Lungor och luftvägar". En artikel kan tillhöra flera sådana kategorier. Kategorin listas som vanliga atom-kategorier utan schema på varje artikel. Exemplet med astma har följande kategorier:

<category term="Allergier och överkänslighet"/>
<category term="Lungor och luftvägar"/>

Den andra kategoritypen motsvarar boxarna på landningssidan för en kategori, t.ex. "Sjukdomar och besvär" och "Undersökningar". Kategorierna listas med schemat"http://1177.se/api/ext/cat/parent/"

<category term="Sjukdomar" scheme="http://1177.se/api/ext/cat/parent/" />

Den tredje kategoritypen talar om vilka teman sidan ligger i och läggs bara till om sidan finns i ett temaområde. Kategorierna listas med schemat "http://1177.se/api/ext/cat/theme/"

<category term="Cancer" scheme="http://1177.se/api/ext/cat/theme/" />

Om artikeln går att hitta under flera olika platser så kommer kategorierna hämtas från samtliga ställen sidan finns på.

Senast uppdaterad:
2010-12-02
Redaktör:

Maria Bång, 1177.se