Begreppsbanken som API
Boverkets begreppsbank beskriver vanligt förekommande ord och begrepp kopplade till Boverkets sakområde. Alla ord och begrepp är tillgängliga via ett externt tillgängligt API och även som webbtjänst.
API-tjänst i Boverkets utvecklarportal
API-tjänsten för Boverkets begreppsbank är en REST-API webbtjänst, vilket betyder att den använder sig av https-protokollet för att ta emot och returnera data. För att kommunicera med tjänsten används http-metoder. API-tjänsten finns tillgängligt på Boverkets utvecklarportal.
Information i tjänsten
Tjänsten tillhandahåller begreppsbanken och innehåller termposter med termer och begrepp med tillhörande vägledningstexter, synonymer, bilder och referenser. Tjänsten innehåller också metadata om termposterna i form av giltighetstid och versionshantering.
Informationen som finns i tjänsten levereras via ett publikt tillgängligt API. För mer information om hur API kan konsumeras och vilka villkor som gäller, se mer under rubriken ”Användarvillkor”.
Innehåll och struktur
Boverkets begreppsbank är en platt "katalog" uppbyggd med ordlistor och termposter. En termpost innehåller en term, eller rubrik, och en kortfattad förklaring av termen, begrepp. Vidare kan det finnas längre förklaringstexter, synonymer och referenser kopplade till en termpost. Slutligen finns det information om versionshantering samt möjligheter till att använda bilder och termen på andra språk.
Innehållet är tillgängligt både genom fritextsökningar och direktåtkomst av specifika begrepp. Innehållet görs tillgängligt i JSON och bilder skickas som BASE64. För de som använder NTRF formatet finns det även möjlighet att hämta hela ordlistor i NTRF-format.
Användarvillkor
Genom att använda API-tjänsten bekräftar du att du har läst, förstått och godkänt användarvillkoren som gäller för tjänsten. Boverket friskriver sig från ansvar för all form av skada som kan uppkomma vid användningen av denna katalog.