API und Integrationen

Erfahre, wie Du die Payrexx-API nutzen und Payrexx damit an Drittsysteme wie E-Commerce- oder CMS-Tools koppeln kannst.

Die Abkürzung "API" steht für Application Programming Interface. Man versteht darunter einen Satz von Befehlen, Funktionen und Protokollen, mit dem eine Software mit einem anderen System interagieren kann.

Um eine bestehende API-Integration zu bearbeiten oder eine neue zu erstellen, navigiere in Hauptmenü Deines Payrexx-Kontos zu API und Integrationen.

Wenn Du bereits API-Integrationen erstellt hast, siehst Du sie auf der rechten Seite des Fensters.

Aktive Integrationen von Drittsystemen in Payrexx

Neue API-Integration hinzufügen

Um über die API ein neues Drittsystem hinzuzufügen, klicke im unteren Bereich der Seite auf die weisse Schaltfläche "API-Schlüssel hinzufügen":

Hinzufügen eines neuen API-Schlüssels in Payrexx

Gib der Integration einen beliebigen Namen und klicke auf "Hinzufügen".

Vergabe eines beliebigen Namens für die Integration

Sobald die Integration erstellt ist, findest Du sie in der Liste und kannst ihren API-Schlüssel kopieren, den Du dann im zu integrierenden Drittsystem an der richtigen Stelle eingibst.

API-Schlüssel der neu erstellten Integration

Neue E-Commerce-Integration hinzufügen

Im unteren Bereich der Seite "API & Integrationen" können verschiedene E-Commerce-Systeme wie WooCommerce, Shopify, Gambio und viele mehr an Payrexx gekoppelt werden.

Hinzufügen von E-Commerce-Integrationen zu Payrexx

Mehr zu diesem Thema findest Du auf der folgenden Seite:

E-Commerce | DEUTSCH | Docs

Nebst E-Commerce-Lösungen können auch andere Software-Systeme in Payrexx eingebunden werden:

Content-Management-Systeme (CMS)Unternehmenssoftware

Log-Files anzeigen

Zu jeder API-Integration gibt es Log-Files, die die Kommunikation, das heisst alle API-Anfragen, zwischen Payrexx und dem jeweiligen E-Commerce-System aufzeichnen und allfällige Fehler anzeigen. Um das Log-File anzusehen, klicke beim jeweiligen E-Commerce-System einfach auf den Button "Logs":

Log-Files der Integration mit PrestaShop anzeigen

Du siehst nun eine Liste der API-Anfragen zwischen Payrexx und dem gewählten E-Commerce-System, im folgenden Beispiel PrestaShop:

Auszug aus der Liste der API-Anfragen

Durch einen Klick in die jeweilige Zeile öffnet sich im rechten Bereich des Fensters die Detailansicht zur gewählten API-Anfrage, hier am Beispiel einer Integration mit Shopware 6:

Beispiel einer API-Anfrage der Integration mit Shopware 6

Weitere Informationen zu API

In der Entwickler-Dokumentation von Payrexx findest Du weitere Informationen zu API:

Developer