API and Plugins

In this article, you will learn how to use our API to connect Payrexx with e-commerce platforms, CMS solutions, and other third-party systems.

The abbreviation "API" stands for Application Programming Interface. It refers to a set of commands, functions, and protocols that allow one software application to interact with another system.

Creating an Integration Using a Plugin

Plugins are available for the following third-party systems, allowing you to set up the integration automatically. Click the respective link to open the integration guide:

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

Further information on connecting Payrexx to software solutions can be found in the following articles:

E-Commerce Systems | ENGLISH | Docsdocs.payrexx.com

Content Management Systems (CMS) | ENGLISH | Docsdocs.payrexx.com

Business Software | ENGLISH | Docsdocs.payrexx.com

Creating an Integration via API

Please ensure that you are using the latest Payrexx API version 1.13.

If you are using a system for which no plugin is available, you can set up the integration manually via our API. To do so, navigate to API and Plugins in the merchant dashboard of your Payrexx account.

• Click "Add API Key" to create a new API-based integration:

Creating an API Key in Payrexx

• Assign any name to the integration (1) and click "Add" (2):

Assigning the name and creating the API Key

• Once the API key has been created, you will find it under API and Plugins in the list, where the following functions are available:

The created API Key in the list

1. Copy: Copies the value of the API key to the clipboard.

2. Logs: Displays a list of all log entries associated with this API Key.

3. Configuration: Opens the API Key in edit mode, where you can change its name or regenerate the key.

View Log Files

For every API integration, whether via a plugin or manually through the API, log files are available that record all API requests between Payrexx and the respective third-party system, and display any errors. Follow these steps to view the log file:

• Navigate to API and Plugins in the merchant dashboard.

• Click "Logs" next to the desired entry:

Accessing the Log File of a Plugin-Based Integration in WooCommerce

Accessing the Log File of a Manually Created Integration

You will now see a list of API requests between Payrexx and the chosen e-commerce system, in this example, PrestaShop:

Excerpt from the list of API requests

By clicking on a specific row, the details of the selected API request will appear in the right section of the window. Here is an example of an integration with PrestaShop:

Example of an API request for the integration with PrestaShop

Additional Information on API

For more information about API, refer to the Payrexx developer documentation:

Overview | Developerdocs.payrexx.com