Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 59 Next »

OBS: Denne side vedrører kun version 2 af API’et. Søger du generel information eller version 1 information bedes du læse API Design (V1)

Introduktion

Arbejdet med version 2 af KITOS API blev igangsat i foråret 2021 og udvikles i fem etaper:

Formålet med arbejdet er at stille et funktionelt og komplet API til rådighed hvorigennem interessenter, rettighedshavere, leverandører og kommuner kan læse/skrive data fra/til KITOS samtidig med at forretningsreglerne overholdes og stamdataene derfor forbliver anvendelige.

Version 2 skrives fra bunden af og i tæt samarbejde med de anvendende interessenter.

Udfases version 1?

Version 1 af API’et vil, på sigt, blive udfaset i den forstand at det ikke længere bliver muligt at tilgå det med KITOS token. Før dette kan ske skal Version 2 dog kunne opfylde de integrationsbehov der findes, og udfasningen vil blive meldt ud i god tid.

Designbeslutninger

API’et udvikles med afsæt i de logiske grupperinger (moduler/rodaggregater) der eksisterer i KITOS. Data udstilles via et REST API, hvorigennem man i første omgang vil kunne benytte sig af følgende HTTP verber:

Grundlæggende gives der adgang til de samme data som brugeren i øvrigt har adgang til via KITOS UI. Forskellene opstår ved inspektion af de enkelte ressourcer, hvor UI i nogle tilfælde kombinerer data fra flere moduler (selv under navngivne modulsider) så vil API’et i bred udstrækning tillade at det samme information findes men kun der hvor det registreres.

UUID’er

I KITOS API vil alle ressourcer være tildelt en UUID, der er garanteret unik og garanteret stabil uanset ændringer i den bagvedliggende struktur. I Version 1 har man typisk anvendt “Id” feltet på ressourcerne - et felt der primært er tiltænkt databasens relationsmodel, men som, af mangel på bedre, har været anvendt som identifikation på ressourcer trukket ud via API’et. Dette ændres der på i Version 2 hvor kun UUID er gyldigt som identifikation for ressourcer i KITOS.

Paginering på listeudtræk

På de API endpoints hvor der tilbydes listeudtræk skal man forholde sig til paginering via følgende query parametre:

  • pageSize [1-(100 | Ubegrænset)]: Antal resultater pr. svar.

    • Hvis det ikke defineres, vil Swagger dokumentation angive standardværdien. Det fremgår samtidigt her hvorvidt maksimal pageSize er 100 eller ubegrænset.

  • page: [0-Int.MaxValue]: Offset i resultaterne. Offset vil være (pageSize * page)

    • Hvis det ikke defineres vil KITOS bruge 0 som standardværdi

Eksempel:

https://kitos.dk/api/v2/it-systems?page=0&pageSize=50

Bemærk: Udelades pagineringsparametre vil KITOS benytte standardværdierne fra API dokumentationen. For endpoints hvor pageSize er ubegrænset, vil en udeladt værdi resultere i at hele resultatsættet returneres i et enkelt kald.

Centreret omkring rod-aggregater

Rodaggregaterne (modulerne) i KITOS vil være omdrejningspunktet for KITOS API’et herunder:

  • IT-Systemer fra kataloget (stamdata)

  • IT-Systemer i organisationen (lokale registreringer i forlængelse af stamdata fra kataloget)

  • Snitflader

  • Kontrakter

  • Databehandling

Herudover vil der være en række understøttende API’er der typisk leverer læse-adgang til en række tilknyttede ressourcetyper herunder fx:

  • Udfaldsrum

  • Organisationer

  • Brugere i organisationen

Målsætningen er ikke, at man skal kunne alt det man kan i hele KITOSU UI (administration af udfaldsrum f.eks.), men indenfor rodaggregaterne skal man kunne hente og skrive alt hvad man ellers er i stand til via UI, uden at det nødvendigvis er på samme form.

Krydsreferencer

Når en ressource refererer til en anden ressource - f.eks. en snitflade der refererer et udstillersystem - så vil KITOS API tilføje en krydsreference. En krydsreference er en simpel datastype, der (som minimum) indeholder navn (name) og en id (uuid). Detaljeret information kan hernæst findes via det REST API, der findes for den krydsrefererede type.

Eksempel

Fra snitflade API’et returneres en krydsreference til udstillersystemet:

{
..,
exposedBySystem: {
    name: "test",
    uuid: "ccb5a066-3e14-489a-a9d4-91193e12d53d"
  }
..
}

For at hente information om udstillersystemet tilgås API’et for IT-Systemer (stamdata):

HTTP GET https://kitos.dk/api/v2/it-systems/ccb5a066-3e14-489a-a9d4-91193e12d53d

Ønsker man ikke at hente systeminformationen ud har man dog stadig et navn (meningsfuldt for mennesker) såvel som en UUID, der benyttes iftm. senere operationer på API’et.

Informationen findes der hvor den registreres (og kan opdateres)

I KITOS UI vil man typisk kunne finde den samme information flere steder. Dette kan give mening for at lette brugervenligheden og overblikket i en UI sammenhæng men for API brugere er det vigtigt at stamdata findes det samme sted hver gang.

Et eksempel herpå kunne være:

  • Udstillede snitflader: I UI vises dette både på IT-Systemet i kommunen samt på stamdata fra kataloget. Logisk set er snitfladen knyttet til stamdata så i API vil udstillede snitflader altså findes ved at trække information ud fra IT-System-stamdata hvortil der vil være en krydsreference i udtrækket fra kommunens egne data.

  • Et andet eksempel kunne være systemhierarki, der i dag vises på IT-Systemet i kommunen. Ligesom udstillede snitflader registreres denne information på stamdata, hvorfor den også skal hentes her. Hierarkiet dannes via udtræk af stamdata og opbygning af hierarki via “ParentSystem”.

Tilsvarende eksempler kunne beskrives for andre scenarier men strategien eksisterer for at gøre det tydeligt hvor data opstår og hvor det efterfølgende kan vedligeholdes.

Opdateringer

Modsat Version 1 tilbyder Version 2 også skrivning af data. Afhængigt af rettigheder tilbydes:

  • Oprettelse af nye ressourcer

  • Rettelse af eksisterende ressourcer

  • Nedlæggelse (sletning/deaktivering) af eksisterende ressourcer.

Obligatoriske og valgfrie felter

Ifm. oprettelse og tilretning, vil man i API dokumentationen blive præsenteret for felter der enten er obligatoriske eller valgfrie (markeret med optional) i swagger:

Obligatoriske felter SKAL altid være til stede ifm. enten PUT eller POST. Valgfrie felter MÅ gerne være til stede. Såfremt de ikke leveres, nulstilles de af KITOS ifm. POST eller PUT.

PUT og PATCH

I første omgang tilbydes rettelser via anvendelse af PUT og i begrænset omfang via PATCH.

I PUT leveres alt data til den nye version af ressourcen. Dette betyder at udfylder man ikke et valgfrit felt i json dokumentet der sendes ifm. PUT, så nulstiller KITOS data for dette felt. Da data kan have været opdateret i KITOS anbefales det derfor at skrive ændringer via API via følgende protokol:

  • GET ressourcen, der skal ændres via GET api/v2/{ressource-type}/{uuid}

  • Flet data fra den seneste version fra KITOS med ændringer der skal skrives

  • PUT resultatet af fletningen.

Når PATCH anvendes er det for at muliggøre opdatering af en delmængde af ressourcen dvs. man skal i denne sammenhæng ikke levere en fuld opdatering men kan nøjes med at opdatere den del af data som er relavant.

Hvilket PATCH format anvendes

KITOS' (forudsat https://os2web.atlassian.net/browse/KITOSUDV-2358 ) understøtter PATCH jf. JSON Merge Patch standarden: https://datatracker.ietf.org/doc/html/rfc7396

Begrænsninger i PATCH

Indtil https://os2web.atlassian.net/browse/KITOSUDV-2358 er løst, tilbydes PATCH med begrænset opløsning, hvor valgfriheden tilbydes på “rod-niveau”. Dette er eksemplificeret nedenfor:

Udgangspunktet er følgende, komplette, datakontrakt:

{
  "name": "a name",
  "general" : {
      "enabled": false,
      "localId": "a local id"
  },
  "parentUuid" : "CF397900-4550-4E6C-A2AC-C329BBBB7475"
}
Scenario 1: Opdatering af “name”

“name” er et felt på “rod-niveau” dvs. det ligger i roden af datakontrakten, og derfor kan det opderes 100% uafhængigt af andre felter:

PATCH /api/v2/{ressouce}/{uuid}
{
  "name": "a new name"
}

Ovenstående payload vil resultere i en opdatering af “name” og kun “name”.

Scenario 2: Opdatering af “localId”

For localId bemærkes, at dette ligger på en sektion “general”, men at det ligger på linje med andre felter som forventes leveret i samme request. Derfor vil følgende request være korrekt:

PATCH /api/v2/{ressouce}/{uuid}
{
  "general" : {
      "enabled": {current_enabled_state_fetched_Before_patch},
      "localId": "a new local id"
  }
}

Udelades “enabled” fra requestet, vil KITOS nulstille dette felt til standardværdien.

Scenario 3: Opdatering af “name” og parentUuid

Opdatering af flere felter i roden af kontrakten fungerer på linje med opdatering af et enkelt felt. Man kan derfor formulere følgende request:

PATCH /api/v2/{ressouce}/{uuid}
{
  "name": "a new name",
  "parentUuid" : "B47C7EF7-E7B3-4FD5-B7B8-B4C4CA78BBD9"
}

Derved vil kun “name” og “parentUuid” blive opdateret, og sektionen “general”, og alle data herunder, vil forblive uberørt.

Scenario 4: Nulstilling af sektioner/felter

Såfremt feltet optræder på rodniveau, vil det blive evalueret, så hvis der f.eks. leveres “null” til “general”, så vil det blive opfattet som “nulstilling af general-sektionen og alle data herunder”.

PATCH /api/v2/{ressouce}/{uuid}
{
  "general" : null
}

Forretningsreglerne er stadig gældende

De forretningsregler/begrænsninger man er vant til via KITOS UI er stadig gældende ifm. anvendelse af API’et.

Vejledning til rettighedshavere

Der er udarbejdet særlige endpoints til rettighedshavere. Se særskilt vejledning her: Vejledning til rettighedshavere (API brugere med rettighedshaveradgang)

Swagger

Se venligst Swagger dokumentation

  • No labels