REST API

Die konfipay-API ist ein leistungsstarker Webservice, der auf den Prinzipien der REST-Architektur (Representational State Transfer) basiert. REST ist ein weit verbreiteter Standard für die Entwicklung von Webservices und zeichnet sich durch seine Einfachheit, Flexibilität und Plattformunabhängigkeit aus. Die API nutzt typische REST-Merkmale wie die Verwendung von HTTP-Verben (z. B. GET, POST, PUT, DELETE) zur Durchführung von Operationen, standardisierte HTTP-Statuscodes zur Kommunikation von Erfolgen oder Fehlern sowie Content Negotiation, um die optimale Darstellung der Daten basierend auf den Anforderungen des Clients bereitzustellen.

Für die sichere Übertragung der Daten wird das Protokoll HTTP (Hypertext Transfer Protocol) in Kombination mit TLS (Transport Layer Security) verwendet. TLS gewährleistet eine verschlüsselte und abhörsichere Kommunikation zwischen Client und Server, wodurch die Vertraulichkeit und Integrität der übertragenen Informationen sichergestellt wird.

Die API unterstützt JSON (JavaScript Object Notation) als Datenformat. JSON ist ein kompaktes und leicht lesbares Format, das aufgrund seiner einfachen Struktur und guten Kompatibilität mit modernen Webanwendungen weit verbreitet ist.

Der Funktionsumfang der konfipay-API umfasst verschiedene Bankdienstleistungen gemäß dem SEPA-Standard (Single Euro Payments Area), der den europaweiten Zahlungsverkehr standardisiert und vereinfacht. Darüber hinaus bietet die API die Möglichkeit, auf ein PayPal-Konto zuzugreifen, um Transaktionen und Kontostände abzurufen sowie Rückerstattungen durchzuführen. Diese Kombination aus SEPA- und PayPal-Funktionalitäten macht die API zu einer vielseitigen Lösung für den modernen Zahlungsverkehr.

Inhalt dieses Artikels

In diesem Artikel werden zwei zentrale Aspekte der konfipay-API ausführlich beschrieben:

1. Fehlercodes der API:

   • Es wird ein umfassender Überblick über die verschiedenen Fehlercodes gegeben, die im Falle von Fehlern oder ungültigen Anfragen von der API zurückgegeben werden.

   • Die Fehlercodes sind in verschiedene Kategorien unterteilt und folgen einem strukturierten Aufbau nach dem Schema ERR-{Category}-{Number}. Jede Kategorie deckt einen spezifischen Bereich ab, wie z. B. ungültige Parameter, Validierungsfehler oder Verarbeitungsfehler.

   • Zu jedem Fehlercode wird eine detaillierte Beschreibung bereitgestellt, die die Ursache des Fehlers und gegebenenfalls die erforderlichen Maßnahmen zur Behebung erläutert.

API-Fehlercodes

2. Beschreibung der API-Versionen:

   • Die konfipay-API wird kontinuierlich weiterentwickelt, um neue Funktionen bereitzustellen und bestehende Prozesse zu optimieren.

   • In diesem Artikel werden die verschiedenen API-Versionen vorgestellt, einschließlich der unterstützten Funktionen, der wichtigsten Änderungen und der Kompatibilität zu älteren Versionen.

   • Besonderes Augenmerk liegt dabei auf der Angabe, welche Funktionen in den jeweiligen Versionen verfügbar sind und welche Version für bestimmte Anwendungsfälle empfohlen wird.

Durch die strukturierte Darstellung der Fehlercodes und die detaillierte Beschreibung der verschiedenen API-Versionen dient dieser Artikel als umfassende Referenz für Entwickler, die die konfipay-API in ihre Anwendungen integrieren möchten.
API-Versionen