Systemintegration & API-dokumentation – Gränssnitt, fältmappning och Excelregister | Word/PDF/Excel

Systemintegration & API-dokumentation är ett digitalt mallpaket för IT-projekt, systemförvaltning och utvecklingsteam som behöver dokumentera hur två system utbyter information. Skapa gränssnittsbeskrivningar, fältmappning, felhanteringsrutiner, testprotokoll och versionsunderlag. Paketet innehåller 15 dokumentfiler i Word, sökbar PDF och Excel i en digital ZIP-fil.

Vad är en integrationsspecifikation?

En integrationsspecifikation beskriver vilket system som producerar respektive tar emot information, dataformat och utbytesmetod, förväntade svar, felhantering, säkerhet och ansvar. Den används exempelvis mellan affärssystem, e-handel, ekonomisystem, CRM och andra applikationer. Mallen ger ett redigerbart dokumentationsunderlag, men är inte en exekverbar API-implementation, automatisk OpenAPI-generator eller validerad systemkoppling.

Samtliga dokument och format

Excelregistret – nio flikar med tydliga kontrollpunkter

Excel innehåller Översikt, Integrationer, Endpoints, Fältmappning, Felkoder, Tester, Risker, Ändringar och Beslut. Koppla poster via unika integrations-ID:n. Registerkontrollen kan markera ”OK” eller ”SAKNAS” för referenser. Riskpoäng beräknas utifrån en intern skala 1–5 för sannolikhet och konsekvens. Exempeltröskeln 15 är ett administrativt uppföljningsmått, inte en automatiskt fastställd acceptansnivå. Verkliga tekniska kontroller och formella beslut måste genomföras separat.

Så använder du paketet

1. Registrera integrationen med unikt ID och tydligt ägarskap.
2. Beskriv källsystem, målsystem, flödesriktning, format, frekvens och verksamhetsnytta.
3. Dokumentera fält, transformationsregler, validering och schemareferenser.
4. Bedöm informationens skyddsbehov, behörigheter, loggning och eventuella personuppgifter.
5. Planera testfall, felhantering, återförsök, idempotens och eventuell återställning.
6. Genomför faktiska integrationstester och samla evidens i godkänd testmiljö.
7. Fastställ versionshantering, beslutsmandat, förvaltning och översyn.

Vilka andra Mallbutiken-produkter kompletterar detta?

För generella systemförvaltningsrutiner finns Systemförvaltningsplan & IT-systemregister. För ett separat uppdrag att genomföra acceptansprovning finns Acceptansprovning & Leveransgodkännande IT. Om ni behöver avtalsreglering mellan SaaS-parter finns SaaS-avtal enligt svensk rätt. Dessa är separata produkter med annat fokus.

Vanliga frågor om API- och integrationsdokumentation

Ingår en maskinläsbar OpenAPI-fil?

Nej. Paketet innehåller Word, PDF och Excel, inte OpenAPI i JSON eller YAML. För verklig OpenAPI-validering behöver ni ett godkänt maskinläsbart API-schema och ett lämpligt tekniskt verktyg.

Kan jag dokumentera filöverföringar och andra gränssnitt än REST?

Ja. Formulären är metodneutrala där det är möjligt och har fält för protokoll, filöverföring, händelsebaserade flöden och andra utbytesmönster. Anpassa fält och krav efter den faktiska lösningen.

Kontrollerar Excel att API:erna fungerar?

Nej. Excelkontrollen avser registerreferenser och enkel riskberäkning. Den gör inga API-anrop och verifierar inte att ett gränssnitt fungerar, är tillgängligt eller är säkert.

Vad innebär ett datakontrakt?

Ett tekniskt underlag som beskriver format, fält, datatyper, obligatoriska värden och versionsregler för ett informationsutbyte. Mallen skapar inte automatiskt ett juridiskt bindande avtal mellan parter.

Kan jag använda skarpa personuppgifter i testexemplen?

Undvik detta. Använd syntetiska data och verksamhetens egna skydds- och testdataprocesser. Ange aldrig lösenord, API-nycklar, tokens eller andra hemligheter i mallarna.

Är PDF-filerna ifyllningsbara?

De är sökbara och utskrivbara. Redigera Wordversionerna och Excelarbetsboken för att fylla i uppgifter. Interaktiva PDF-formulär ingår inte.

Är mallarna certifierade enligt ISO, OpenAPI eller någon myndighetsstandard?

Nej. De är fristående dokumentmallar med metodreferenser. Faktiska krav beror på organisation, avtal, teknik och vilka regelverk som är tillämpliga. Ingen extern säkerhets- eller juristgranskning har genomförts.

Vilka språk ingår?

De fem operativa dokumenten och den svenska användarguiden är på svenska. En separat English User Guide förklarar hur filerna används, men huvudmallarna är inte översatta till engelska.

Metodkällor och version

Metodstöd från Digg – vägledning för information och API:er, Digg – REST API-profil 1.2.0, OpenAPI Specification och GDPR artikel 32 via IMY. Offentliga standarder och vägledningar har egna tillämpningsområden och utgör inga godkännanden av Mallbutikens dokument. Dokumentversion 1.0, 29 oktober 2026. AI-assisterad metodkontroll, ingen extern specialistgranskning.