Überblick

Webservices ermöglichen den automatisierten und systemübergreifenden Austausch von Geschäftsdaten über standardisierte Webprotokolle. Sie basieren typischerweise auf Technologien wie HTTP/HTTPS, SOAP oder REST und ermöglichen eine direkte Kommunikation zwischen Anwendungen.

Die Kernmerkmale von Webservices umfassen:

• Standardisierte Kommunikation über Webprotokolle.
• Automatisierter Datenaustausch zwischen Anwendungen und Systemen, unabhängig von Plattform.
• Unterstützung verschiedener Datenformate, beispielsweise XML oder JSON.
• Echtzeit-Datenübertragung, wodurch Informationen unmittelbar verarbeitet werden können.
• Flexible Integration in bestehende IT-Systeme wie ERP-, Warenwirtschafts- oder Logistiksysteme.
• Sichere Datenübertragung durch Verschlüsselung und Authentifizierungsmechanismen (z. B. TLS, API-Keys oder Zertifikate).
• Hohe Skalierbarkeit und Erweiterbarkeit, wodurch neue Partner oder Systeme einfach angebunden werden können.

Unterstützte Nachrichtentypen (TYPES):

• ORDERS – Bestellung
• ORDRSP – Bestellbestätigung
• ORDRCHG – Bestelländerung
• DESADV – Lieferavis
• RECADV – Wareneingangsbestätigung
• INVOIC – Rechnung
• INVRPT – Bestandsbericht
• DELFOR – Lieferplan
• IFTMIN – Transportauftrag
• PRODAT – Produktdaten
• APERAK – Bestätigungsnachricht
• REMADV – Zahlungsavis
• SORDERS – Sammelbestellung
• HANMOV – Lagerbewegung

Übermittlung von Daten an uns

Namen der Dateien:
Alphanumerische Zeichen (a-z, A-Z, 0-9)
Sonderzeichen: „-„, „.“, „_“, „~“

Feldbeschreibung:
Die einzelnen Felder haben folgende Bedeutung:

• name
  Dateiname der übertragenen Datei.
  Wird zur Identifikation der Datei im System verwendet und muss pro Datei eindeutig sein.
• type
  Nachrichtentyp (EDI-Typ), der den Inhalt der Datei beschreibt.
  Beispiele:
  • ORDERS
  • INVOIC
  • DESADV
• content
  Inhalt der Datei.
  Die Originaldatei muss vor der Übertragung in einen Base64-String umgewandelt werden.

{
    "name": "22a2ac8f-9bb3-4938-9425-31079a5fa9bc",
    "type": "ORDERS",
    "content": "dGhlIGNvbnRlbnQgbXVzdCBiZSBiYXNlNjQgZW5jb2RlZA=="
}

curl -L \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
https://bridge.test.service.avenum.com/v1 \
-d '{"type":"ORDERS","content":"dGhlIGNvbnRlbnQgbXVzdCBiZSBiYXNlNjQgZW5jb2RlZA=="}'
  

Daten von uns abrufen

curl -L \
  -X POST \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://bridge.test.service.avenum.com/v1/out/INVOIC

[
    {
       "name": "test-1"
       "type": "INVOIC",
    },
    {
       "name": "test-2"
       "type": "INVOIC",
    }  
]

Dateiinhalt abrufen

GET /out/${type}/${name}

Liefert die Datei mit dem angegebenen Typen und Namen.

{
"name": "Name der Datei",
"type": "Typ der Datei",
"content": "Inhalt der Datei (Base64 encoded)"
}

200 OK = Alles hat ordnungsgemäß funktioniert
403 Forbidden = Keine Berechtigung oder falsche Zugangsdaten
404 Not found = Der verlangte Inhalt konnte nicht gefunden werden

Datei löschen

DELETE /out/${type}/${name}

Löscht die Datei mit dem angegebenen Typen und Namen.

Wichtig: Abgerufene Dateien werden nicht automatisch gelöscht. Die Datei muss nach erfolgreicher Verarbeitung aktiv gelöscht werden.

204 No content = Alles hat ordnungsgemäß funktioniert
403 Forbidden = Keine Berechtigung oder falsche Zugangsdaten
404 Not found = Der verlangte Inhalt konnte nicht gefunden werden