Registrati

API und Integrationen

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.

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:

WooCommerceShopware 6
Magento 2PrestaShop
WHMCS (partner integration, BlueRabbit)

Further information on connecting zahls.ch to e-commerce systems can be found under E-commerce.

Creating an Integration via API

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 zahls.ch account.

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

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

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

  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 zahls.ch 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.

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

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.

Additional Information on API

For more information about the API, refer to the zahls.ch developer documentation:

Developer Guides API Reference

Argomenti correlati