# Zammad Integration

Zammad ist ein Open-Source-Helpdesk-System, mit dem Sie alle Kommunikationskanäle Ihres Unternehmens von derselben Plattform aus verwalten können. Dank der REST API kann Zammad problemlos in bestehende Systemumgebungen implementiert werden.

Verbinden Sie sipgate und Zammad und profitieren von der automatischen Kontaktsynchronisierung. Alle Änderungen oder neuen Kontakte, die Sie in der sipgate App während oder nach dem Telefonat hinzufügen, werden automatisch in Zammad gespeichert.

**Integration von Zammad in der sipgate App:**

{% stepper %}
{% step %}

#### Integration auswählen

Klicken Sie in der sipgate App links auf das Zahnrad und wählen Sie den Punkt **Integrationen** aus.\
Unter dem Punkt **Integrationen** suchen Sie den Eintrag **Zammad** und klicken auf die Schaltfläche **Mit Zammad verbinden**. ![](https://327448942-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg0qj71PeONPljdPedXLf%2Fuploads%2Fgit-blob-5758269bda09463b3edc87334818535df5c5b558%2Fmceclip0.png?alt=media)
{% endstep %}

{% step %}

#### API-Daten eingeben

Geben Sie hier den benötigten API-Key und die API-URL ein.

![](https://327448942-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg0qj71PeONPljdPedXLf%2Fuploads%2Fgit-blob-a640b21aad2a855b8d92b56941a407e45fdf4f44%2Fmceclip1.png?alt=media)
{% endstep %}

{% step %}

#### Verbindung bestätigen

Damit haben Sie Zammad und die sipgate App erfolgreich verbunden.

{% hint style="info" %}
Hinweis: Je nach Anzahl der zu integrierenden Kontakte kann es einige Minuten dauern, bis diese vollständig angezeigt werden.
{% endhint %}
{% endstep %}
{% endstepper %}

**API-Key in Ihrem Zammad-Account finden bzw. erstellen:**

Klicken Sie in Ihrem Account links unten auf das Benutzersymbol und wählen den Punkt "Profil".

![Zammad1](https://327448942-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg0qj71PeONPljdPedXLf%2Fuploads%2Fgit-blob-936f794bc86e4058c92c7c07d695e281c05ca0ad%2FZammad1%20Kopie.png?alt=media)

Öffnen Sie nun den Menüpunkt "Token-Zugriff" und klicken Sie auf die Schaltfläche "Erstellen".

![Zammad2](https://327448942-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg0qj71PeONPljdPedXLf%2Fuploads%2Fgit-blob-91139b0b0eaa35d301b3a88afa7c16ae50ac8a41%2FZammad2%20Kopie.png?alt=media)

Vergeben Sie jetzt einen Namen für den zu erstellenden API-Key **und wählen aus der Liste bitte die Option "User, Benutzer Verwalten" aus.**

![Zammad3](https://327448942-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg0qj71PeONPljdPedXLf%2Fuploads%2Fgit-blob-734fb730581dbbdd57154ca2c6c05d98d84d99a6%2FZammad3%20Kopie%203.png?alt=media)

Damit haben Sie den benötigten API-Key erstellt. Bitte kopieren Sie diesen Key und fügen ihn entsprechend in der sipgate App ein.

{% hint style="warning" %}
Wichtig: Um das Erstellen & Updaten von CallLogs/-Notizen zu ermöglichen, fügen Sie folgende Berechtigungen dem API-Key hinzu:
{% endhint %}

* **admin.user**
* **admin.organization**
* **ticket.agent**

![Zammad4](https://327448942-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg0qj71PeONPljdPedXLf%2Fuploads%2Fgit-blob-500ab618aedd6d8fefeff90eae2aca3dc37090de%2FZammad4%20Kopie.png?alt=media)

{% hint style="warning" %}
**Wichtig:** Um die selbst gehostete Zammad CRM-Lösung in Ihrem Firewall-Setup zu ermöglichen, müssen Sie die Zammad-Bridge unter zammad.bridge.clinq.com und den Port 443 freigeben. Dies ist erforderlich, damit die sipgate App die CRM-Kontakte erfolgreich laden kann.
{% endhint %}

#### Kontakte Anlegen

Die sipgate-App schreibt neue Kontakte oder ändert Kontakteinträge in Zammad immer in der Rolle **Customer.** Diese Rolle ist in der Grundeinstellung von Zammad vorhanden, kann aber geändert werden. Ist diese Rolle nicht vorhanden, weil der Name überschrieben wurde, oder bestehen weitere Rollen, so kann die sipgate-App in die dafür vorgesehene Rolle nicht schreiben.

#### Hinweise für selbstgehostete Zammad Lösung

Die sipgate<>Zammad-Bridge verwendet folgende APIs, um Kontakte zu syncen sowie CallEvents anzulegen:

* Endpunkte unterhalb von /api/v1/users
* Endpunkte unterhalb von /api/v1/organizations
* Endpunkte unterhalb von /api/v1/tickets\
  \&#xNAN;*Zammad API:* [Introduction — Zammad System Documentation documentation](https://docs.zammad.org/en/latest/api/intro.html#endpoints-and-example-data)\
  \&#xNAN;*Zammad API – User:* [User — Zammad System Documentation documentation](https://docs.zammad.org/en/latest/api/user.html)

Die Zammad CTI-API wird nicht verwendet, da Live-Events bearbeiten damit nicht möglich ist:\
\&#xNAN;*Zammad Generic CTI API:* [Generic CTI — Zammad System Documentation documentation](https://docs.zammad.org/en/latest/api/generic-cti/)