# API and Plugins

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](/merchant/english/integration/e-commerce/woocommerce.md) | [MyCommerce](/merchant/english/integration/e-commerce/mycommerce.md)   | [Odoo](/merchant/english/integration/e-commerce/odoo.md)                               |
| [Shopify](/merchant/english/integration/e-commerce/shopify.md)         | [Ecwid](/merchant/english/integration/e-commerce/ecwid.md)             | [Concrete 5](/merchant/english/integration/content-management-system-cms/concrete5.md) |
| [Shopware 6](/merchant/english/integration/e-commerce/shopware-6.md)   | [Gambio](/merchant/english/integration/e-commerce/gambio.md)           | [Cloudrexx](/merchant/english/integration/content-management-system-cms/cloudrexx.md)  |
| [Shopware 5](/merchant/english/integration/e-commerce/shopware-5.md)   | [JTL Shop 5](/merchant/english/integration/e-commerce/jtl-shop.md)     | [saldiaShop](/merchant/english/integration/e-commerce/saldiashop.md)                   |
| [Magento 2](/merchant/english/integration/e-commerce/magento-2.md)     | [nopCommerce](/merchant/english/integration/e-commerce/nopcommerce.md) | [Drupal](/merchant/english/integration/content-management-system-cms/drupal.md)        |
| [PrestaShop](/merchant/english/integration/e-commerce/prestashop.md)   |                                                                        |                                                                                        |

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

{% embed url="<https://docs.payrexx.com/merchant/v/english/integration/e-commerce>" %}

{% embed url="<https://docs.payrexx.com/merchant/v/english/integration/content-management-system-cms>" %}

{% embed url="<https://docs.payrexx.com/merchant/v/english/integration/business-software>" %}

## Creating an Integration via API

{% hint style="info" %}
Please ensure that you are using the latest Payrexx API version 1.13.
{% endhint %}

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:

<div align="left"><figure><img src="/files/hB6j6UOOn63hMuPq4bfW" alt=""><figcaption><p>Creating an API Key in Payrexx</p></figcaption></figure></div>

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

<div align="left"><figure><img src="/files/M48POJLzkJpb9kKDMKbe" alt="" width="563"><figcaption><p>Assigning the name and creating the API Key</p></figcaption></figure></div>

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

<div align="left"><figure><img src="/files/9cGdLxVbpkvuhalU5aKH" alt=""><figcaption><p>The created API Key in the list</p></figcaption></figure></div>

1. **Copy:** Copies the value of the API key to the clipboard.
2. **Logs:** Displays a list of all [log entries](#view-log-files) 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:

<div align="left"><figure><img src="/files/nRiUlY5Rf97lgZBIMfwu" alt=""><figcaption><p>Accessing the Log File of a Plugin-Based Integration in WooCommerce</p></figcaption></figure></div>

<div align="left"><figure><img src="/files/gsQoQQ1k5wNx5BkGoJFf" alt=""><figcaption><p>Accessing the Log File of a Manually Created Integration</p></figcaption></figure></div>

You will now see a list of API requests between Payrexx and the chosen e-commerce system, in this example, [PrestaShop](/merchant/english/integration/e-commerce/prestashop.md):

<div align="left"><figure><img src="/files/tw1lsgGraEE2cCeeXCbW" alt="" width="530"><figcaption><p>Excerpt from the list of API requests</p></figcaption></figure></div>

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](/merchant/english/integration/e-commerce/prestashop.md):

<div align="left"><figure><img src="/files/5IBelC4xozdQRmd120GJ" alt=""><figcaption><p>Example of an API request for the integration with PrestaShop</p></figcaption></figure></div>

## Additional Information on API

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

{% embed url="<https://docs.payrexx.com/developer>" %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.payrexx.com/merchant/english/account/api-and-plugins.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
