Digital post iframe API. Version 1.4

Transkript

1 Digital post iframe API Version 1.4

2 Versionshistorik Introduktion til digital post iframe API Links Parametre Log på digital post Funktioner Funktion - Indbakke Funktion - Adressebog Funktion - Tilmeldinger... 6

3 Versionshistorik Version Udgivelsesdato Beskrivelse 1.1 Første version 1.2 Tilføjelse af versionshistorik Skrivefejl rettet i eksempel 1.3 Portal-id tilføjet alle eksempler 1.4 Udvidet forklaring til eksempler

4 1. Introduktion til digital post iframe API Dette dokument beskriver de parametre, som kan anvendes ved implementering af digital post iframe i en myndighed eller tværoffentlig portals eget univers. Der vil for slutbrugeren være adgang til alle funktioner. Yderligere kan portalen vælge at tilbyde deeplink til specifikke funktioner heriblandt link til en myndigheds postkasser, mulighed for at skrive til en myndighed eller vise dokumenter. Anvendelse af deeplink kan enten ske i et pop op-vindue eller i en iframe. Digital post-løsningen sørger her for enten at lukke et pop op-vindue eller sende brugeren videre til den mest logiske side. Parametrene beskrevet i afsnit 3.1 skal som minimum altid angives ved kald til digital post. Øvrige funktionsparametre kan angives, hvis en specifik funktion ønskes. 2. Links Link til integrationstestmiljø: Link til produktionsmiljø: 3. Parametre I dette afsnit er listet alle parametre, som anvendes til at kalde digital post: 3.1. Log på digital post Logon borger Log på digital post som privat borger virksomhed Log på digital post som virksomhed Template borger Brug borger.dk design virk Brug virk.dk design default Brug standard design Portalid <id på portalen> Id på portalen som ønsker at tilgå digital post. Portalen skal være oprettet i administrationsportalen hvor det tildelte id vil fremgå. Eksempel (log på digital post som borger med borger.dk design) logon=borger&template=borger&portalid=0

5 3.2. Funktioner function inbox Gå til indbakken addressbook Subscriptions settings Denne funktion kan suppleres med yderligere parametre. Se afsnittet Funktion Indbakke Gå til adressebogen Denne funktion kan suppleres med yderligere parametre. Se afsnittet Funktion Adressebog Gå til tilmeldinger Denne funktion kan suppleres med yderligere parametre. Se afsnittet Funktion Tilmeldinger Gå til indstillinger Eksempel (log på digital post som borger, med borger.dk design og vis slutbrugers indbakke) logon=borger&template=borger&function=inbox&portalid= Funktion - Indbakke Documentid <id på dokumentet> Viser slutbrugers dokument Mailboxid <id på postkassen> Viser skriv besked med en forvalgt postkasse. Subjectid <id på emne> Viser skriv besked en forvalgt postkasse og emne. Parameter kan kun anvendes hvis også mailboxid er angivet. Eksempel (log på digital post som borger, med borger.dk design vis en slutbrugers dokument) logon=borger&template=borger&function=inbox&documentid=0001a01a01a00b00b00b00000&portalid=0 Eksempel (log på digital post som borger, med borger.dk design og vis skriv til en myndigheds postkasse med) logon=borger&template=borger&function=inbox&mailboxid=100&portalid=0

6 Funktion - Adressebog customernumber <nummer på myndighed> Viser postkasser hos valgte myndighed Categoryid <id på kategori> Viser myndigheder i valgte kategori Eksempel (log på digital post som borger og vis postkasser for en myndighed med kundenummer 1234) logon=borger&template=borger&function=addressbook&customernumber=1234&portalid= Funktion - Tilmeldinger customernumber <nummer på myndighed> Viser tilmeldingsmuligheder hos valgte myndighed Categoryid <id på kategori> Viser myndigheder i valgte kategori Eksempel (log på digital post som borger og vis tilmeldinger for en myndighed med kundenummer 1234) logon=borger&template=borger&function=subscriptions&customernumber=1234&portalid=0