eFaktúra Startseite Werkzeuge Für Entwickler
Entwicklerportal

API-Dokumentation für eFaktúra

Dokumentation für Integrationen zu Lookup, Validierung, Versand, Empfang, Webhooks und Audit-Ausgaben. Beschreibt den empfohlenen Deployment-Ansatz, Sicherheitsregeln und Integrationsszenarien.

REST API Sandbox-ready Idempotency-first Webhook events Evidence-friendly

Verfügbarkeit der Schnittstellen

Verfügbare Endpunkte können je nach Umgebung und Deployment-Typ variieren. Produktivschlüssel gehören auf den Server, nicht in den Browser. Das öffentliche Frontend darf private Produktivrouten nicht direkt aufrufen.

Auth

Bearer + Idempotenz

Private API-Schlüssel gehören auf den Server, nicht in Browser-JS. Versand und Retries sollten einen Idempotency-Key verwenden.

Authorization · Idempotency-Key
Lifecycle

Senden + Empfangen + Verarbeiten

Endpunkte berücksichtigen nicht nur den Versand, sondern auch Empfang, Freigaben, Response-Codes, Evidence-Pakete und den Archiv-Flow.

Senden · Empfangen · Evidence
DX

Sandbox und Quickstarts

Ein Integrator braucht einen kurzen Quickstart, Payload-Beispiele, Retry-Regeln, Webhooks und einen klaren Unterschied zwischen Test- und Prod-Modus.

Docs · Beispiele · Webhooks

Enterprise-Integrationsprofil

Für Enterprise-Kunden ist ein vollautomatisierter Ablauf wichtig: Das System nimmt einen Feed entgegen, validiert ihn, konvertiert ihn, sendet ihn und gibt die finalen Artefakte zurück ins Archiv oder ERP.

M2M-Integration REST API Webhook-Rückgabe

Feed, Formate und ICD

Die Integration berücksichtigt einen JSON/XML-Feed, Batch-Verarbeitung und sichere Kanäle wie SFTP. Das Interface Control Document kann die Form einer OpenAPI/Swagger-Spezifikation mit Mapping- und Retry-Regeln haben.

JSON / XML Batch / SFTP ICD / OpenAPI

Fail-Flow und Retry

Bei einem Fehler sollte das System einen detaillierten Grund, die Rule-ID, den XML-Knoten und eine Korrekturempfehlung zurückgeben. Die Korrekturquelle bleibt das Quellsystem, und eFaktúra centrum gibt das Ergebnis per Webhook zurück.

rule_id + detail Retry-Workflow Audit-Trail

Finale Artefakte und Portal

Enterprise-Kunden brauchen oft die finale XML- und PDF-Datei zurück, ein Portal zur Übersicht verarbeiteter Rechnungen und die Möglichkeit, eine eigene, gebrandete PDF-Vorlage vorzubereiten.

PDF-Vorlage Rückgabe finales XML/PDF Portal / Viewer
ICD

ICD & OpenAPI

Vertrag für Feed, Mapping, Fehlerkatalog, Versionierung und Checkliste für Enterprise-Teams.

ICD öffnen →
Events

Webhook Contract

Delivery-Lifecycle, Callback-Payloads, Signaturmodell, Retries und Event-Reihenfolge.

Webhooks öffnen →
Artifacts

Artifact Return & PDF

Rückgabe des finalen XML/PDF, individuelles Vorlagenpaket und Archiv-Übergabe ins interne System des Kunden.

Artifact-Ebene öffnen →
Env

Sandbox vs. Produktion

Promotion-Checkliste, Test-Payloads, Idempotenz-Schutzmaßnahmen und Cutover-Regeln vor dem Livegang.

Modi öffnen →
Rules

Error Catalog

Rule-IDs, Schweregrad, XML-Pfad, Korrekturhinweise und ein Owner-Modell für Enterprise-Triage.

Fehlerkatalog öffnen →
Batch

SFTP & Batch Onboarding

Namenskonventionen, Manifeste, ACK-Dateien, Teil-Retry und Nachvollziehbarkeit für Corporate-Feeds.

Batch-Onboarding öffnen →
Trust

Security & Trust Center

EU-Datenresidenz, Audit-Logs, Aufbewahrung und das Enterprise-Betriebsmodell für die technische Prüfung.

Trust Center öffnen →
Identity

Enterprise Identity

SSO, Lifecycle und Rollen-Governance für Corporate-Tenants und Integrationsteams.

Identity-Ebene öffnen →
Pricing

API & Enterprise Pricing

Pay-as-you-go API, Pläne für Steuerberater und Enterprise-Middleware in einem kommerziellen Modell.

Pricing öffnen →
RBAC

Access Control

Trennung von Admin-, Buchhalter- und Entwicklerrechten inklusive API-Keys und Audit-Rollen.

RBAC öffnen →
Connectors

Integrations

Prioritätsliste von Systemen für den slowakischen Markt mit Kompatibilitätsstatus. Der Import funktioniert bereits mit POHODA XML, KROS-Exporten, Money/MRP CSV und ISDOC; weitere direkte Konnektoren kommen schrittweise dazu.

Integrationen öffnen →
Security

Security Baseline

Technische Baseline für Edge-Header, CORS, Payload-Kontrollen, Auth und Enterprise-Hardening.

Security Baseline öffnen →
Ops

Status & Observability

Statusseite, Webhook-Delivery-Log, Correlation-IDs und Incident-Reporting für Enterprise-Support.

Observability öffnen →
Audit

Audit Export

e-Discovery-Paket für Kunden, die einen XML/PDF/Log-Export für einen Zeitraum benötigen.

Audit Export öffnen →
Automation

Automation Suite

Regeln, PO-Matching, Disputes und Smart Intake für fortgeschrittenere Automatisierungsszenarien.

Automation Suite öffnen →
Network

Global Network

Factur-X, Clearance und Roaming als Multi-Country-Richtung für weitere Integrationen.

Netzwerk-Ebene öffnen →
GET /api/peppol-lookup/:participantId

Partner-Lookup im Format 0245:2020123456. Ausgabe: Registrierung, Name, unterstützte Dokumente, Readiness-Status und empfohlener Kanal.

Live-API / PrüfungPartner-Onboarding
POST /api/validate

Die XML-Validierung liefert rule_id, den Schweregrad des Problems und eine Korrekturempfehlung. In einer lokalen Übersicht sollte immer klar gekennzeichnet sein, dass es sich nicht um ein Produktivergebnis handelt.

ValidierungLokale Übersicht getrennt
POST /api/convert

Excel, CSV oder vorbereitete Exporte als Eingabe, ein ZIP mit fertigen XML-Dateien oder ein Batch-Report als Ausgabe. Geeignet für einen schrittweisen Übergang ohne neues ERP.

KonvertierungPrüfung bei unsicherer Eingabe nötig
POST /api/send

Vorbereitung und Versand des Dokuments über einen angebundenen zertifizierten Partner, mit Schwerpunkt auf Idempotency-Key, Transmission-ID, Evidence und nachfolgenden Response-Events.

Über angebundenen zertifizierten PartnerNach Aktivierung der Anbindung
GET /api/messages/:invoiceId

Übersicht über ACK, NACK, Ablehnung und weitere Events inklusive geschäftlicher Bedeutung und Verarbeitungszeitachse.

Event-ZeitachseLokale Übersicht möglich
GET /api/evidence/:invoiceId

Paket für Audit oder interne Prüfung: Payload, Validierungszusammenfassung, Response-Events, Regelversion und Verarbeitungszeitachse.

Audit / ExportErgänzender lokaler Export

Quickstart

Die folgenden Beispiele dienen als Sandbox- oder serverseitiges Integrationsmuster. Produktiv-URL, Autorisierung und verfügbare Endpunkte hängen vom gewählten Deployment ab.

curl -X POST /api/validate \ -H "Authorization: Bearer $API_KEY" \ -F "files[]=@rechnung001.xml"
const res = await fetch("https://api.verifyeu.com/api/peppol-lookup/0245:2020123456", { headers: { Authorization: "Bearer " + process.env.API_KEY } });
requests.post( "https://api.verifyeu.com/api/send", headers={ "Authorization": "Bearer " + API_KEY, "Idempotency-Key": "invoice-2026-001" }, files={"xml_file": open("invoice.xml", "rb")} )

Auth, Sandbox und Retry-Regeln

Thema
Regel
Auswirkung
API-Keys
Der Schlüssel gehört in die serverseitige Umgebung. Das Frontend sollte das eigene Backend oder einen Proxy aufrufen, nicht öffentliches Browser-JS.
Sicherheit
Verfügbarkeit
Bestätigen Sie vor der Integration, welche Routen in der Produktion verfügbar sind und welche nur zum Testen oder für die lokale Übersicht dienen.
Vertrauen
Sandbox
Erste Integrationen sollten einen Demo-/Mock-Provider, Test-Payloads und ein von der Produktion getrenntes Logging verwenden.
Geringeres Risiko
Idempotenz
Jeder Versand-Versuch über einen angebundenen zertifizierten Partner sollte einen stabilen Idempotency-Key haben. Retries dürfen keine doppelten Rechnungen erzeugen.
Betrieb
Validation Gate
Vor /api/send sollte der Validator laufen, und bei Fehlern sollte das Dokument im Remediation-Flow gestoppt werden.
Compliance
Evidence
Regelversion, Transmission-ID, Response-Zeitachse und Freigabe-Metadaten für den Audit-Trail speichern.
Audit

Was für Enterprise-Anfragen ergänzt werden sollte

Anforderung
Empfohlene Produktantwort
Ebene
Rechnungsfeed
REST API als primärer Kanal, plus Batch oder SFTP für große Corporate-Exporte.
M2M
Formate
JSON/XML als Eingabe, Konvertierung zu PEPPOL BIS 3.0 oder SK CIUS innerhalb der Middleware-Ebene.
Convert
ICD
OpenAPI/Swagger + Mapping-Notizen + Fehlerkatalog + Retry-Regeln + Webhook-Vertrag.
DX
Fehlerbehandlung
Rule-ID, Schweregrad, Knoten/Pfad und erklärbare Korrektur zurückgeben; das Quellsystem korrigiert die Daten und sendet erneut.
Validator
Finales PDF/XML
Nach Validierung und Versand die finale XML- und PDF-Datei per API oder Webhook zurück ins Archiv des Kunden geben können.
Archiv
Portal
Viewer, Inbox und Audit-Trail zu einem seriösen Portal für Finance- und Operations-Nutzer verbinden.
Portal

Webhook-Events

Die Transportebene hat die Zustellung ins Netzwerk oder an den Empfänger bestätigt.

Transport- oder Business-Ablehnung. Öffnet typischerweise den Remediation-Flow.

Bedingte Annahme, Timeout oder ein Konflikt in den Workflow-Daten.

Das Dokument wurde abgeschlossen und mit einem Evidence-Paket zur Archivierung markiert.

Die finale XML- und PDF-Datei sind bereit für die Rückgabe ins interne Archiv oder Billing-System des Kunden.

Developer Guardrails

Eingaben mit geringem Vertrauen sollten durch manuelle Prüfung laufen, nicht durch autonomen Versand.

Peppol ID, Steuernummer, IBAN und Partner-Kennungen müssen vor einem Batch validiert werden.

Ein ACK bedeutet keine geschäftliche Annahme. Der Workflow sollte auf das nächste Response-Event warten.

Bei einem nicht bereiten Partner einen empfohlenen Kanal zurückgeben, nicht nur eine "Partner nicht gefunden"-Meldung.