Kom i gang med utvikling
Formålet med denne siden er å hjelpe utviklere i gang med å ta i bruk funksjonaliteten i eFormidling.
- Kom i gang med utvikling
- Utvikling for tjenesteleverandører
- Kom i gang med eFormidling uten integrasjonspunkt
- Støtte ved utvikling
- Utvikling av eFormidling
- Åpen kildekode
Kom i gang med utvikling
Det aller første en bør gjøre er å lese introduksjon til eFormidling og den overordnede beskrivelsen av funksjonaliteten en skal ta i bruk.
eFormidling leverer en mellomvare (integrasjonspunktet) som gir fagsystem ett enkelt grensesnitt for meldingsutveksling uavhengig av hvilke typer meldinger som utveksles med hvem. Før en kan komme i gang med utvikling bør en ha tilgang til et integrasjonspunkt å utvikle mot. eFormidling tilbyr et offentlig testmiljø sammen med meldingstjenestene som brukes i eFormidling, og integrasjonspunktet må konfigureres med nødvendige tilganger til disse. Se gjerne:
I noen sjeldne tilfeller ønsker en virksomhet å kommunisere med virksomheter på eFormidling uten selv å kjøre et integrasjonspunkt. Dette er mulig, men ikke anbefalt. Se gjerne:
Integrasjonspunktet tilbyr to programmeringsgrensesnitt. Grensesnittet eFormidling 2
anbefales for all nyutvikling.
Det andre grensesnittet, BEST/EDU
, fases ut og omtales derfor ikke mer på denne siden. Grensesnittene er i
utgangspunktet ikke beskyttet, men kan konfigureres med HTTP basic auth og HTTPS.
eFormidling 2
er JSON-basert og støtter helt overordnet følgende funksjonalitet:
- motta meldinger
- sende meldinger
- se status for sendte meldinger
De samme API-kallene brukes uavhengig av aktuelle prosesser, dokumenttyper og meldingstjenester som er involvert. For eksempel følger en publisering til eInnsyn samme flyt som en forsendelse til innbygger. Dette legger til rette for at klientimplementasjoner kan benytte programmeringsmodeller som gjør det enkelt å utvide til nye brukstilfeller.
For å støtte denne modellen bygges alle meldinger med samme grunnleggende struktur.
Standard adresseringsinformasjon] el2[Forretningsmelding
Ekstra adresseringsinformasjon og instruksjoner avhengig av dokumenttypen] end subgraph Kryptert dokumentpakke el3[Associated Signature Container Extended
Signert ZIP-arkiv med strukturert og/eller ustrukturert innhold] end end
Se mer om eFormidlings standard business document (SBD) på:
SBD har en gitt dokumenttype og en tilhørende forretningsmelding:
Se mer om eFormidlings dokumentpakke på:
Se mer om integrasjonspunktets programmeringsgrensesnitt på:
Eksempler er ofte en god måte å komme i gang på. Se eksempler på bruk av de ulike prosessene i eFormidling:
Utvikling for tjenesteleverandører
eFormidling har funksjonalitet for å legge til rette for tjenesteleverandører som tilbyr eFormidling som del av sine tjenester.
- En leverandør kan sende meldinger på vegne av flere virksomheter slik at det ikke er nødvendig med ett integrasjonspunkt for hver enkelt avsendervirksomhet
- En enkelt virksomhet kan bruke flere integrasjonspunkt til ulike formål slik at en virksomhets tjenester kan fordeles på flere tjenesteleverandører
Les mer om leveransemodeller i eFormidling:
Kom i gang med eFormidling uten integrasjonspunkt
I noen sjeldne tilfeller ønsker en virksomhet å kommunisere med virksomheter på eFormidling uten selv å kjøre et integrasjonspunkt. Dette er mulig, men ikke anbefalt.
For å ta i bruk eFormidling uten integrasjonspunkt:
- Oppslag mot eFormidlings adressetjeneste må implementeres for å vite hvilke virksomheter som kan motta hvilket innhold
- Det må settes opp en integrasjon mot eFormidlings meldingstjeneste
- Levering av meldingsstatuser til eFormidlings meldingsstatustjeneste må implementeres
- Forretningsregler som skal sikre at meldinger sendes dit mottaker ønsker dem, påkrevd varsling, osv. må implementeres
- Flyten i ønsket prosess må implementeres inkludert integrasjoner med eventuelle andre meldingstjenester som kreves av en prosess
- Eventuell øvrig meldingsfunksjonalitet (køing, feilhåndtering, …) som ønskes må implementeres
Støtte ved utvikling
- eFormidling på Digdir Docs
- Generell støtte til eFormidling tilbys av servicedesk@digdir.no
- eFormidling ønsker ved behov å tilby utvidet støtte til de som implementerer integrasjoner mot eFormidling. Ta kontakt med servicedesk@digdir.no og spør om mulighet for å få en Slack-kanal inn mot eFormidlings team.
Utvikling av eFormidling
eFormidling utvikles løpende ihht. gjeldende strategi. Nye behov og konkrete endringsønsker tas imot og prioriteres løpende.
Åpen kildekode
Det meste av eFormidling er tilgjengelig som åpen kildekode:
- Integrasjonspunktet på GitHub (ekstern lenke)
- Adressetjenesten (Service Registry) på GitHub (ekstern lenke)
- Alt fra eFormidling på GitHub (ekstern lenke)
- Implementasjon av Associcated Signature Container Extended (ASiC-e) på GitHub (ekstern lenke)