Denna beskrivning gäller API av ovanstående version.

Generellt om användning

API distribuerar information som publiceras löpande vilket betyder att omfattningen av den informationen som är tillgänglig via API varierar över tid.

För att kunna hantera uppdateringar och förändringar av innehåll som hämtats via API behöver konsumerande system bygga funktionalitet för att hantera uppdateringar av information som hämtats från API. Detta ansvar vilar på konsumenter av API.

För hantering av uppdateringar stödjer API två konsumtionsmönster:

• Uppdatering styrd av konsumerande system

• Uppdatering styrd av notifieringar vid förändringar

Uppdatering styrd av konsumerande system

Detta innebär att konsumerande system periodiskt anropar tjänster i API för att kontrollera om ny eller uppdaterad information finns att hämta.

Uppdatering styrd av notifieringar

Konsumenter kan registrera sig för att ta emot notifieringar om uppdatering av innehåll. Detta medför att konsumerande system inte behöver genomföra anrop annat än vid notifierade förändringar.

Rent praktiskt betyder detta att konsumerande system utvecklar funktionalitet för att ta emot notifiering samt funktionalitet för att reagera på aktuell notifiering (t.ex att hämta en uppdatering av ett kunskapsstöd).

Tillgänglig information

Teknisk lösning & Test

Tekniska detaljer om utformning och tjänsterna i API hittar du på https://api-sys.kunskapsstod.se/info/swagger-ui/. Här kan du även testa funktionalitet (kräver API-nyckel).