API‑Dokumentation

Die proxxmail API ermöglicht die Integration sicherer, revisionsfähiger Kommunikations- und Meldesysteme in bestehende Infrastrukturen. Sie ist minimalistisch gehalten, klar dokumentiert und für Audits optimiert.

1. Überblick

Die API ist modular aufgebaut und unterstützt:

• Entgegennahme vertraulicher Meldungen
• Audit‑Trail‑Export
• System‑ und Statusabfragen
• Integration externer Vertrauensdienste (eIDAS)

2. Endpunkte (Basis)

Alle Endpunkte folgen einer klaren, stabilen Struktur:

POST /api/v1/meldung
GET  /api/v1/meldung/{id}
GET  /api/v1/audit/export
GET  /api/v1/system/status
  

Beispiel: Meldung einreichen

POST /api/v1/meldung
Content-Type: application/json

{
  "betreff": "Produktsicherheitsmeldung",
  "beschreibung": "Fehlerhafte Seriennummer 2024-XYZ",
  "anhang": null
}
  

3. Authentifizierung

Die API verwendet statische Tokens oder signierte Requests (abhängig vom Einsatzszenario). Für Pilotpartner stellen wir individuelle Zugangsdaten bereit.

4. Audit‑Trail

Alle Vorgänge werden deterministisch protokolliert. Der Export erfolgt über:

GET /api/v1/audit/export?format=json
GET /api/v1/audit/export?format=csv
  

5. Integration externer Dienste (eIDAS)

proxxmail unterstützt die Anbindung qualifizierter Vertrauensdienste:

• Qualifizierte elektronische Signaturen (QES)
• Qualifizierte Zeitstempel (TSA)
• Identitätsdienste (eID, Wallet‑Pilotprojekte)
• Qualifizierte Zustelldienste

Die Dokumentation externer Anbieter wird hier verlinkt, sobald eine Integration aktiv ist.

6. Pilotpartner‑Zugang

Pilotpartner erhalten:

• erweiterte API‑Endpunkte
• Test‑ und Sandbox‑Umgebungen
• technische Unterstützung
• Dokumentation zu Zertifizierungs‑Schnittstellen

Kontakt

Für API‑Zugang, technische Fragen oder Pilotprojekt‑Teilnahme:
kontakt@proxxmail.de