Registrieren

API und Integrationen

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.

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:

WooCommerceShopware 6
Magento 2PrestaShop
WHMCS (Partnerintegration, BlueRabbit)

Weitere Informationen zur Anbindung an E-Commerce-Systeme findest du unter E-Commerce.

Erstellen einer Integration über die API

Falls du ein System verwendest, für das kein Plugin existiert, kannst du die Integration über unsere API manuell vornehmen. Navigiere hierfür im Dashboard deines zahls.ch-Kontos zu API und Integrationen.

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

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

  • 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.

  1. Kopieren: Kopiert den Wert des API-Schlüssels in die Zwischenablage.
  2. Logs: Zeigt eine Liste sämtlicher Log-Einträge dieses API-Schlü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 zahls.ch und dem jeweiligen Drittsystem aufgezeichnet und allfällige Fehler angezeigt werden. Gehe wie folgt vor, um das Log-File anzusehen:

  • Navigiere im Dashboard zu API und Integrationen.
  • Klicke beim gewünschten Eintrag auf "Logs".

Du siehst nun eine Liste der API-Anfragen zwischen zahls.ch und dem gewählten E-Commerce-System.

Durch einen Klick in die jeweilige Zeile öffnet sich im rechten Bereich des Fensters die Detailansicht zur gewählten API-Anfrage.

Weitere Informationen zur API

In der Entwickler-Dokumentation von zahls.ch findest du weitere Informationen zur API:

Developer Guides API-Referenz

Verwandte Themen