REST endepunkt

Blanketmotoren understøtter REST-afsendelser i JSON-format.

API versionering

I modsætning til SOAP-afsendelser kan man ved REST-afsendelser vælge, hvilken API-version man ønsker at få afsendelser sendt i - såfremt flere versioner er udgivet, hvilket ikke er tilfældet i skrivende stund.

Hvis man konfigurerer blanketten til at bruge “latest version”, vil man altid have de seneste features og nyeste API-format af REST-API, i fald disse er udgivet.

Man kan dog også specificere, at blanketten skal bruge en specifik version af REST-API, hvilket betyder, at API-formatet i så fald ikke vil blive udskiftet, selvom nyere features/formater er udgivet.

REST-afsendelse API

API versioner

Version 1

Felter i version 1:

Felt	Hvad indeholder feltet	Hvornår er feltet tilføjet

Felt	Hvad indeholder feltet	Hvornår er feltet tilføjet
xmlData	Blankettens XML-fil encoded i base64	Altid
pdfData	Blankettens PDF-fil encoded i base64	Altid
metadata.formmetadata	Metadata fra redigerbare metadatafelter	Hvis der er redigerbare metadatafelter
metadata.indsendtblanketmetadata	Se “Indsendt blanket-metadata”	Altid
metadata.betalingmetadata	Se “Betalingsmetadata”	Hvis blanketten har betaling
metadata.underskriftmetadata	Se “Underskriftsmetadata”	Hvis blanketten har underskrifter
vedhaeftninger	Vedhæftede filer og info til fil	Hvis blanketten har vedhæftede filer
kvittering	Kvitterings-PDF, der blev sendt til anmelder, encoded i base64	Hvis send kvitteringskopi til myndigheder er slået til i kvitteringskonfiguration, og der er blevet afsendt kvittering til anmelder.

Indsendt blanket-metadata

Felt	Hvad indeholder feltet

Felt	Hvad indeholder feltet
`indsendtBlanketDocumentId`	Blanketdesigners dokument id
`indsendtBlanketId`	Indsendt blanket id
`indsendtBlanketNavn`	Navn på blanketdesigneren
`documentDate`	Dato for blanketindsendelsen
`documentTime`	Tidspunkt for blanketindsendelsen
`ip`	IP-nummer og host for indsenderen

Betalingsmetadata

Felt	Hvad indeholder feltet

Felt	Hvad indeholder feltet
`ordreid`	Blankettens reference for en indsendt blanket til en betaling
`paymentid`	EASY Payment’s id for en betaling

Underskriftsmetadata

Felt	Hvad indeholder feltet

Felt	Hvad indeholder feltet
`email`	Underskriverens email
`cprUuid`	OIOSAML3-UUID for borger som underskrivere
`cpr`	Underskriverens CPR-nummer, for borgere som underskrivere
`navn`	Underskriverens navn
`professionalUuid`	OIOSAML3-UUID for medarbejder som underskrivere
`cvr`	Underskriverens CVR-nummer, for medarbejder som underskrivere
`signatureProof`	XML-fil der indeholder MitID-underskriften af dokumentet, produceret af NemLogin
`time`	Tidspunkt for underskriften

Eksempel på afsendelse

{
"xmlData": <base64-encoded xml>,
"pdfData": <base64-encoded pdf>,
"metadata": {
"formmetadata": {
"test": "321"
},
"indsendtblanketmetadata": {
"indsendtBlanketDocumentId": "07e024a57e442f12ccf0e70e3a750eee7953c818",
"indsendtBlanketId": "13577",
"indsendtBlanketNavn": "BMTO-2988",
"documentDate": "2024-01-24",
"documentTime": "11:19:26",
"ip": "for=185.153.154.186;host=blanketdev.virk.dk,host=blanketdev.virk.dk"
},
"betalingmetadata": {
"ordreid": "BLAN-L-LOCAL-607",
"transaktionsid": null, // Burde slettes da det ikke er brugt længere
"paymentid": "0230000065a512e98f3ccbf6be8c63c9"
},
"underskriftmetadata": [
{
"email": "medsignerer@et.dk",
"cprUuid": "df41625e-6138-425c-adc8-88c9c9eebc99",
"cpr": "3107771092",
"navn": "Putte",
"professionalUuid": "",
"cvr": "",
"signatureProof": <base64-encoded xml>,
"time": "2024-01-24 11:19:26"
}
]
},
"vedhaeftninger": [
{
"filnavn": "Test 1.pdf",
"filreference": "1b187a10a4141aaf547124ed159abcfbcdbd798b.bin",
"mimetype": "application/pdf",
"fildata": <base64-encoded fildata>
}
],
"kvittering": <base64-encoded pdf>
}

Blanketmotor Wiki