Skapa ett användarkonto och få åtkomst till Företagsdatalabbets API

Företagsdatalabbet har ett API som kan användas för att skapa innovativa lösningar. Med API:et kan du hämta historisk information om aktiebolag.

För att kunna använda API:et måste du först registrera dig.

Innehåll på den här sidan

Förkunskaper du behöver för att använda API:et
Vilken information kan du hämta med API:et?
Hur du skapar ett användarkonto och når API:et
Kontakt och support

Förkunskaper du behöver för att använda API:et

För att kunna använda API:et bör du ha vissa tekniska kunskaper inom

programmering – framför allt kunna utveckla en webbklient som anropar API:et.
HTTP.

Vilken information kan du hämta med API:et?

Du kan hämta information som gäller företag. Informationen är uppdelad per år, så det är möjligt att göra en jämförelse hur ett visst företag har förändrats över åren.

Informationen om företaget är relativt detaljerad och omfattar exempelvis:

namn
organisationsnummer
säte
aktiekapital
information om ärenden.

Hur du skapar ett användarkonto och når API:et

Här får du hjälp med att skapa ett användarkonto och få åtkomst till API:et, samt tips på vad du ska tänka på när du ska utveckla en applikation som anropar API:et.

Hur du skapar ett användarkonto och blir medlem

Innan du skapar ett konto behöver du känna till användarvillkoren för Företagsdatalabbets API och hur dina personuppgifter behandlas .

Kom ihåg att använda en e-postadress som kommer att finnas kvar lika länge som din applikation. Undvik personliga företagsadresser då dessa inte går att använda om personerna slutar på företaget.

Du blir medlem genom att registrera dig som användare via Bolagsverkets API-Gateway, WSO2.

Öppna sidan portal-accept2.api.bolagsverket.se/devportal/apis .
Klicka på SIGN-IN i övre högra hörnet:
Klicka på länken Registrera i nedre delen av inloggningsrutan.
Klicka på länkarna för att läsa hur vi behandlar vi dina personuppgifter när du registrerar dig via vårt formulär och användarvillkoren.
Skriv in dina användaruppgifter, förnamn, efternamn, lösenord och e-post. Uppgifterna är obligatoriska. Bocka i rutan för att acceptera villkoren och klicka sedan på knappen Registrera.
När du har klickat på Registrera får du ett mejl med en verifieringslänk till din registrerade e-postadress. Klicka på länken i mejlet för att aktivera ditt användarkonto.
Nu kan du logga in i Bolagsverkets WSO2 Developer Portal med ditt användarkonto genom att klicka på SIGN-IN.

Hur du når Företagsdatalabbets API

För att kunna hämta data via Företagsdatalabbets API behöver du konfigurera åtkomst i Bolagsverkets WSO2 Developer Portal.

1. Skapa en applikation

För att kunna nå Företagsdatalabbets API behöver du skapa en applikation på WSO2.

Logga in i Bolagsverkets WSO2 Developer Portal portal-accept2.api.bolagsverket.se/devportal/apis och klicka på Applications i toppmenyn.
Skapa en ny applikation genom att klicka på ADD NEW APPLICATION
Skriv in ett passande applikationsnamn. Välj hur många frågor applikationen får ställa per genererad Access Token och skriv in en beskrivning. Mer om Access Tokens kan du hitta under rubriken Vad du ska tänka på när du utvecklar en applikation som anropar Företagsdatalabbets API.

När du är klar klickar du på SAVE.

2. Skapa åtkomstnycklar

För att en applikation ska kunna nå ett publicerat API behöver den ha åtkomstnycklar.

Gå till applikationen du vill skapa åtkomstnycklar till.

I menyn klickar du på Sandbox Keys.
Här kan du konfigurera åtkomstnycklarna att passa din applikation. Vi rekommenderar att du inte gör några ändringar i detta steg om du är osäker på vad du kommer att använda senare.

Klicka på GENERATE KEYS när du är nöjd med konfigurationen.
Kopiera och spara undan den Access Token som genererats. Klicka sedan på CLOSE.
Upprepa steg 2 och 3 men för Production Keys genom att klicka på Production Keys i menyn till vänster.

3. Prenumerera på Företagsdatalabbets API

Klicka på APIs i toppmenyn.
Klicka på Foretagsdatalabbet.
Klicka på knappen SUBSCRIBE under rubriken Subscriptions.
Välj vilken av dina applikationer som ska prenumerera på API:et i rullistan och klicka på SUBSCRIBE.

4. Hämta data från Företagsdatalabbets API

Gå till Företagsdatalabbets API och klicka på Try Out i menyn.
Klicka på knappen GET TEST KEY för att hämta din Access Token eller klistra in den Access Token du sparat sedan tidigare. Tänk på att en Access Token har en validitetsperiod på 60 minuter så du kan komma att behöva generera en ny om den blivit för gammal.
I nedre delen ser man API:ets olika operationer. För att testa att hämta företagsstatistik, klickar du på /foretagsstatistik.
Klicka på Try it out.
Här kan du läsa om de olika parametrar operationen hanterar.

Fyll i län och kommun enligt de exempel som visas vid respektive ruta.

Vi rekommenderar att du även skriver in exempelvis 5 i rutan för size för att snabba på hämtningen.
Klicka på Execute för att göra anropet mot Företagsdatalabbets API.
API:et svarar nu med en JSON innehållande företagsdata.
Gratulerar! Du har gjort ditt första API-anrop mot företagsdatalabbets API.

Här kan du nu utforska API:et ytterligare innan du går vidare med att utveckla en egen klient.

Observera att operationen "foretagsstatistiktotaldump" inte fungerar inifrån WSO2 eftersom svaret är för stort.

Vad du ska tänka på när du utvecklar en applikation som anropar Företagsdatalabbets API

När du utvecklar en applikation som ska använda sig av Företagsdatalabbets API finns det vissa saker man behöver veta, exempelvis hur man skapar upp Access Tokens från sin applikation.

1. Access Tokens

När du anropar ett API måste en valid AccessToken användas. Det är en stor fördel om den genereras dynamiskt från din applikation så du slipper fråga efter en ny varje gång.

Enligt OAuth2 finns det ett antal olika sätt att göra detta. Det enklaste är att använda sig av Client Credentials och om du ska göra på det sättet ser du till att denna Grant Type är vald för dina åtkomstnycklar.

Adress som används för att generera ny Access Token: https://gw-accept2.api.bolagsverket.se/token.

2. Generera en Access Token via cURL

Gå till din applikation och välj nyckeln du vill använda i menyn. I exemplet syns Sandbox Keys.

Klicka på CURL TO GENERATE ACCESS TOKEN.
Du får nu upp två olika cURL-kommandon Den första använder Grant Type av typen Password medan den andra använder Client Credentials. Välj vilken du vill ha och klicka på kopierings-ikonen till höger om ditt alternativ.
Du kan nu klistra in det som kopierats till valfri prompt med cURL och köra kommandot med all åtkomstinformation förifyllt.

När du kör kommandot får du ett JSON-formaterat svar med din Access Token.

{"access_token":"DinJättelångaAccessToken","scope":"am_application_scope default","token_type":"Bearer","expires_in":3600}

3. Generera en Access Token från din applikation

Eftersom du kan använda i stort sett vilket programmeringsspråk som helst för din applikation är det svårt att ge konkreta tips på hur du exakt ska göra.

För att du ska få ett dynamiskt flöde kan du exempelvis följa dessa konceptuella steg:

Generera en Access Token genom att skicka en POST-request till https://gw-accept2.api.bolagsverket.se/token med din åtkomstinformation i headern.
Håll koll på när denna Access Tokens validitetsperiod tar slut.
Gör de anrop du behöver mot Företagsdatalabbets API.
När validitetsperioden närmar sig slutet tar du bort Access Token genom att göra en POST-request till https://gw-accept2.api.bolagsverket.se/revoke med din åtkomstinformation.
GOTO 1.

4. Anropa Företagsdatalabbets API från din applikation

När Access Token är under kontroll är det dags att göra anrop mot Företagsdatalabbets API.

5. URL:er som gäller

Bas-URL:en för alla anrop mot de publicerade API:er på denna server är https://gw-accept2.api.bolagsverket.se.

Information om Företagsdatalabbets API hittar du i WSO2 genom att klicka på APIs i toppmenyn och sedan på Foretagsdatalabbet.

Här ser du Context.
Du ser även ett antal endpoints under Resources.

Från denna information sätter du ihop de URL:er man ska gå emot, bas-URL + /foretagsdatalabbet/1.0.0 + Resource.

Exempelvis: https://gw-accept2.api.bolagsverket.se/foretagsdatalabbet/1.0.0/foretagsstatistik.

6. Gränssnittsbeskrivning

Gränssnitten är beskrivna enligt OAS3.

För att ladda hem denna klickar du på APIs och sedan Foretagsdatalabbet. Välj Try out i menyn.
Klicka på SWAGGER (/SWAGGER.JSON) och gränssnittsbeskrivningen laddas hem.

Happy coding!

Kontakt och support

För att kontakta oss på Företagsdatalabbet mejlar du foretagsdatalabbet@bolagsverket.se .