API - Schnittstellen:
In das Virtuelle Kuvert können über API-REST-Schnittstellen auch andere Systeme Dokumente einliefern. Das Sammelkriterium ist dann nicht das Vertragskonto. Es kann eine beliebige andere Kennung sein, zum Beispiel eine Geschäftspartnernummer oder eine Kundennummer, direkt aus dem erzeugenden System.
Eigenschaften der Schnittstelle:
- REST Representational State Transfer
- YAML / JSON als Datenformat
- HTTPS
- multipart/form-data
Request
POST Host: {modwork-host}
Authorization: Basic xxxxxxxx<
User-Agent: ...
Accept: */*; version=2
Content-Length: ...
Content-Type: multipart/form-data; ------WebKitFormBoundaryBu8OOmdWgn6zP51I
Content-Disposition: form-data; name="meta"
Content-Type: application/yaml
workflow:
belegart: https://{modwork-host}/{modwork-basepath}/api/belegart/2171
buchungskreis: https://{modwork-host}/{modwork-basepath}/api/buchungskreis/1234
modwork_einzeldruck_einzeldruck:
belegnummer: 12345
color: CMYK
formular:
id: TEST
name: Testformular
order: 50
formularname: Testformular
virtuelle_kuverts:
- bkr: '1234'
grouping_id: ID_123
land: Deutschland
name: Name
ort: Musterstadt
plz: '12345'
print_date: 2020-11-24
strhnr: Strasse 123
vknr: '20496749'
zusatzbeschreibung: Zusatzbeschreibung------WebKitFormBoundaryBu8OOmdWgn6zP51I
Content-Disposition: form-data; name="files"; filename="document.pdf"Content-Type: application/pdf
{content of document.pdf}
------WebKitFormBoundaryBu8OOmdWgn6zP51I--
