Anslutningsprocess

Allmänt

Att ansluta till API innebär en utvecklingsinsats i det system som skall anslutas för att konsumera information.

Målet är att processen för anslutning skall vara enkel. Dock finns en del hållpunkter som vi önskar följa bl.a. för att etablera en kontakt med konsumenter av API i syfte att kunna meddela planerade förändringar. Nedanstående figur beskriver anslutningsprocessen.

1. Uppstartsmöte

För att starta upp processen önskar vi genomföra ett uppstartsmöte för att informera om funktion och tjänster i API och om processen för anslutning.

2. Beställ API-nyckel för testning

Stagemiljön (testmiljö för integratörer) har egen API-nyckel som måste beställas av NKK-förvaltningen.

För att att använda API behöver det anropande systemet en API-nyckel. Nyckeln används för att identifiera det anropande systemet i syfte att kunna utföra behörighetskontroll samt för att hålla reda på aktuella anslutningar.

3. Utveckling & test

Utveckling och test av API sker hos den anslutande konsumenten.

Kontakta NKK-förvaltningen efter genomförda tester för Utvärdering och återkoppling(nästa steg).

4. Utvärdering & Återkoppling

NKK-förvaltningen arbetar kontinuerligt med förbättring av vårt stöd i form av tekniska lösningar och dokumentation för att underlätta anslutningen för konsumenter. I detta syfte önskar vi återkoppling som kan genomföras på ett möte med oss eller skriftligen beroende på vad som passar.

Aktuella frågor för återkoppling:

  • Genomgång av testresultatet - Några problem eller felaktigheter som upplevts?

  • Eventuella behov gällande funktionalitet i API - Finns behov av ytterligare funktionalitet?

  • Återkoppling om information gällande API och dess användning - Är dokumentationen tillräcklig, något som saknas?

  • Annat stöd som NKK-förvaltningen lämpligen bör ge till anslutande konsumenter?

5. Beställ API-nyckel för PROD

Produktionsmiljön har egen API-nyckel som måste beställas av NKK-förvaltningen.

För att att använda API behöver det anropande systemet en API-nyckel. Nyckeln används för att identifiera det anropande systemet i syfte att kunna utföra behörighetskontroll samt för att hålla reda på aktuella anslutningar.

6. Anslutning PROD

Efter avslutade tester kan en anslutning ske till produktionsmiljön (PROD).

7. Klaranmälan till förvaltning

Förvaltningen önskar att anslutande parter meddelar när en anslutning skett till produktionsmiljön och hämtning av information har genomförts.