PayPal

Zweck

Der PayPal Connector bietet eine umfassende Schnittstelle zur Integration mit der PayPal REST API. Er wurde entwickelt, um vielfältige Finanz- und E-Commerce-Vorgänge zu automatisieren, darunter Rechnungsstellung, Zahlungen, Auszahlungen sowie die Verwaltung von Produktkatalogen und Webhooks. Mit diesem Connector lassen sich folgende Aufgaben erledigen:

• Rechnungen verwalten: Entwürfe erstellen, an Kunden senden, bestehende Rechnungen aktualisieren, Zahlungen erfassen und Rechnungen stornieren.

• Zahlungen und Auszahlungen abwickeln: Zahlungsdetails abrufen sowie Auszahlungen an andere PayPal-Nutzer erstellen, verwalten und stornieren.

• Produktkataloge verwalten: Produktinformationen im PayPal-Konto erstellen, aktualisieren und abrufen.

• Benachrichtigungen automatisieren: Webhooks erstellen und verwalten, um Echtzeit-Updates zu PayPal-Ereignissen zu erhalten.

• Bestellungen verarbeiten: PayPal-Bestellungen erstellen und abrufen.

Praktische Anwendungshinweise

• Authentifizierung: Automatische Verwaltung der Authentifizierung über Client ID und Client Secret. Ein Bearer-Token wird vom PayPal OAuth2-Endpunkt angefordert, sicher gespeichert und bei Bedarf erneuert. Alle API-Aufrufe werden automatisch mit diesem Token authentifiziert.

• Teilaktualisierungen: Aktionen, die bestehende Ressourcen aktualisieren (z. B. UpdateProduct, UpdateInvoice), verwenden die PATCH-Methode. So können nur die zu ändernden Felder gesendet werden.

• Idempotenz: Zur Vermeidung doppelter Vorgänge kann die Option „Create PayPal-Request-Id“ aktiviert werden. Dies fügt jedem POST- und PATCH-Request einen eindeutigen PayPal-Request-Id-Header hinzu, sodass wiederholte Anfragen nur einmal verarbeitet werden.

• Paginierung: Listenanfragen (z. B. „Get Invoices“, „Get Products“) unterstützen Pagination über die Query-Parameter page und page_size.

Authentifizierung

Die Authentifizierung erfolgt mit Client ID und Client Secret, um ein Bearer-Token für den API-Zugriff zu erhalten.

• URL: Basis-URL der PayPal API (z. B. https://api-m.sandbox.paypal.com für Sandbox).

• Client ID: Client ID aus dem PayPal-Entwickler-Dashboard.

• Client Secret: Zum Client ID gehöriges Client Secret.

Ein- und Ausgabeerwartungen

Eingabe

Der Connector bietet eine formularbasierte Oberfläche zur Auswahl der gewünschten Aktion. Die benötigten Parameter variieren je nach Aktion.

• Pfadparameter: Für Aktionen an einer bestimmten Entität (z. B. „Get Invoice By Id“) ist die Angabe einer ID (invoiceId) erforderlich.

• Query-Parameter: Für Listenabrufe können optionale Parameter zur Paginierung verwendet werden, z. B. page und page_size für „Get Invoices“.

• JSON-Body: Beim Erstellen oder Aktualisieren von Daten (z. B. „Create Draft Invoice“, „Update Product“) muss ein data-Objekt im JSON-Format mit den relevanten Attributen übergeben werden.

Ausgabe

Der Connector liefert die API-Antwort in einem Standardformat zurück.

• response: Enthält den Body der API-Antwort im JSON-Format.

• header: Wenn die Option „Header einschließen“ aktiviert ist, enthält dieses Feld die Antwort-Header.

• createResponseDataStructure: Mit dieser Aktion kann aus der response eine Datenstruktur erzeugt werden, um die Ausgabe leichter in nachfolgenden Schritten zu verwenden.