API und Integrationen

In diesem Artikel erfährst Du, wie Du unsere API nutzt, um Payrexx mit E-Commerce-, CMS- und anderen Systemen von Drittanbietern zu verbinden.

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.

Erstellen einer Integration mittels Plugin

Für die folgenden Drittsysteme bestehen Plugins, mit denen Du die Integration automatisch vornehmen kannst. Klicke auf den jeweiligen Link, um die Anleitung zur Integration aufzurufen:

WooCommerce	MyCommerce	Odoo
Shopify	Ecwid	Concrete 5
Shopware 6	Gambio	Cloudrexx
Shopware 5	JTL Shop 5	saldiaShop
Magento 2	nopCommerce	Drupal
PrestaShop

Weitere Informationen zur Anbindung an Softwarelösungen findest Du in den folgenden Artikeln:

E-Commerce | Docsdocs.payrexx.com

Content-Management-Systeme (CMS)Unternehmenssoftware

Erstellen einer Integration über die API

Bitte stelle sicher, dass Du die aktuelle API-Version 1.13 von Payrexx nutzt.

Falls Du ein System verwendest, für das kein Plugin existiert, kannst Du die Integration über unsere API manuell vornehmen. Navigiere hierfür in der Händler-Administration Deines Payrexx-Kontos zu API und Integrationen.

• Klicke auf "API-Schlüssel hinzufügen", um eine neue Integration über die API zu erstellen:

Erstellen eines API-Schlüssels in Payrexx

• Gib der Integration einen beliebigen Namen (1) und klicke auf "Hinzufügen" (2):

Vergabe des Namens und Erstellen des Schlüssels

• Sobald der API-Schlüssel erstellt ist, findest Du ihn unter API und Integrationen in der Liste, wo die folgenden Funktionen zur Verfügung stehen:

Der erstellte API-Schlüssel in der Liste

1. Kopieren: Kopiert den Wert des API-Schlüssels in die Zwischenablage.

2. Logs: Zeigt eine Liste sämtlicher Log-Einträge dieses API-Schüssels an:

3. Konfiguration: Öffnet den API-Schlüssel im Bearbeitungsmodus, wo Du den Namen ändern oder den Schlüssel neu generieren kannst.

Anzeigen der Log-Files

Zu jeder API-Integration, sei es über ein Plugin oder manuell über die API, gibt es Log-Files, in denen alle API-Anfragen zwischen Payrexx und dem jeweiligen Drittsystem aufgezeichnet und allfällige Fehler angezeigt werden. Gehe wie folgt vor, um das Log-File anzusehen:

• Navigiere in der Händler-Administration zu API und Integrationen.

• Klicke beim gewünschten Eintrag auf "Logs":

Aufrufen des Log-Files einer über das Plugin erstellten Integration in WooCommerce

Aufrufen des Log-Files einer manuell erstellten Integration

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 zur API

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

Developer