Jämförda versioner

Nyckel

  • Dessa rader lades till.
  • Denna rad togs bort.
  • Formateringen ändrades.

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. Principen är att hämta informationen till eget system, mellanlagra informationen och sedan uppdatera varefter förändringar sker.

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 hantering av att hantera uppdateringar av informationsmängderinformation 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

Detta innebär att konsumenter kan registrera sig för att ta emot notifieringar om uppdatering av innehåll. Rent praktiskt betyder detta att konsumerande system utvecklar funktionalitet för att ta emot notifiering samt funktionalitet för att reagera på notifieringen (t.ex hämta uppdatering av kunskapsstöd).

Tillgänglig information

Teknisk lösning

...

Mer om detta finns på sidan Konsumtionsmönster

Teknisk lösning & Test av API

Tekniska detaljer om utformning och tjänsterna i API hittar du på https://api.kunskapsstod.se/v2/swagger/

Här kan du även testa funktionalitet (kräver API-nyckel).