Indhold
Introduktion
Formål
Denne guide har som formål at give et overblik over <>.
<Denne guide er tilegnet klienter til NSP og specifikt den leverede komponent/service. Denne del skal være tilstrækkelig for en klientleverandør, som skal udvikle aftagersystemer. Heri tilgodeses specielt referencer til andre dokumenter, da en anvender også skal have en bredere forståelse af den anvendte komponent og eventuelle omgivelser.>
Beskrivelse
<Formål og beskrivelse af komponenten/servicen>
<Eventuel link til mere uddybende beskrivelse, intern på NSP og eksternt>
Tegning og sammenhængen
<Tegning(er) der letter forståelsen og viser relevante sammenhængen>
Læsevejledning og forudsætninger
Dette dokument er henvendt til udviklere og arkitekter, der skal anvende <> .
Det forventes at læseren har kendskab til <f.eks.: SOAP WebService, Den Gode WebService (DGWS) og Sercurity Token Service (STS), o.a.>
<Eventuel andre forudsætninger>
Sikkerhed
<Forudsætninger for anvendelse og krævede adgange, whitelistinger etc., Sikkerhedsniveau. Angiv krav til authentication for at kunne bruge servicen/komponenten.>
| Service udstil type | <Angiv typen, f.eks. DGWS, IDWS, ...> |
| Krævede adgange | <Angiv adgange som er nødvendige for anvendere for at kunne benytte servicen/komponenten> |
| Whitelisting | <Angiv eventuel nødvendig whitelisting> |
| Krævet sikkerhedsniveau | <Angiv krav til authentication for at kunne bruge servicen/komponenten> |
| Forudsætninger for anvendelse | <Angiv forudsæntninger som er nødvendige for at kunne bruge servicen/komponenten, eventuelle nødvendige kald til andre services, etc.> |
| Logning | <Angiv om og hvad der logges> |
| <evt. yderligere krav eller forhold> |
<Eventuel nærmere introduktion>
<Eventuel yderligere beskrivelse af området / domænet som servicen/komponenten servicerer>.
<Samt yderligere information som er vigtigt for anvendelsen eller forståelsen>
Definitioner og referencer
| Reference | Beskrivelse |
|---|---|
Dokument historik
| Dato | Ansvarlig | Beskrivelse |
|---|---|---|
| dd/mm-yyyy | Initiel version |
Adgang, brug og snitflader
Adgang
<Beskrivelse af hvordan service/komponent bruges, snitflade(r), endpoints, og andet relevant>
| Tilgængelig | <Angiv på hvilke(n) NSP-installation(er) servicen/komponenten er tilgængelig> |
| Endpoint(s) | <Angiv udstillede endpoint(s), og hvad de hedder.> |
| WSDL | <Angiv henvisning til WSDL(er). For ekstern anvendbare services typisk på https://wsdl.nspop.dk/> |
| Beskrivelse af services | <Beskrivelser af service(s) / actions på endpoint(s). I lægmands termer beskrive hvad man kan forvente af de enkelte services.> |
| Namespaces etc | <Angiv eventuelt Namespaces, eksterne typer, ..> |
Snitfladebeskrivelse og fejlbeskeder
<Beskrivelse af Snitfladerne.>
<snitflade 1>
<Beskrivelse af hver snitflade input/output>
<snitflade 1>Request
<beskrivelse af request>
<Marker hvilke der er obligatoriske. Gerne en beskrivende tekst på samtlige parametre, og gerne også et eksempel på hvilke data der kan sættes ind her. Selv hvis man forstår beskrivelsen, så er det stadig godt at have et eksempel. Angiv hvis der er undtagelser eller specielle hensyn>
| <navn> | ||
|---|---|---|
| Element | Beskrivelse | Påkrævet |
<snitflade 1>Response
<beskrivelse af svar>
| <navn> | ||
|---|---|---|
| Element | Beskrivelse | Påkrævet |
<snitflade 2, osv.>
<Eventuel generelle koder, værdier, etc.>
Fejlbeskeder
<Beskrivelse af fejlbeskeder, og i hvilke situationer man kan forvente at se disse i.
Noter omkring ting som går på tværs af services. Det kan være fejl som optræder generelt og som man skal være opmærksom på.>
Eksempler
Eksempler på request og response til de operationer der udstilles. De enkelte elementer er beskrevet under snitfladebeskrivelse.
<eksempel 1 på ..>
<mere eksempel>
Test
<beskriv Test muligheder, test-systemer og eventuelle testdata>
Eksempel kode
<Eksempel kode. Det er meget lettere at lave sin egen implementering, hvis man kan kigge efter en anden ....>
Eksempel klient
<og evt. eksempel klient, hvor det giver mening>