Skip to content

Commit 19f5822

Browse files
Update README.md
Update Readme
1 parent 1d9d779 commit 19f5822

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

README.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,49 @@
1-
# contao-zammad-nc-api
2-
API Anbindung zum [Ticket System Zammad](https://zammad.com/) über ein Gateway des Notification-Center
1+
# Zammad API Schnittstelle
2+
API Anbindung zum [Ticket System Zammad](https://zammad.com/) über ein eigenes Gateway des Notification Centers.
33

44
## Beschreibung
5-
Die Schnittstelle sendet Formulardaten direkt als neues Ticket an Zammad.
6-
Falls ein Kontakt in Zammad nicht angelegt ist, wird dieser ebenfalls erzeugt.
5+
Über die Schnittstelle können Formulardaten direkt als neues Ticket an Zammad gesendet werden. Falls ein Kontakt in Zammad nicht gefunden wird, wird dieser ebenfalls erzeugt. Im Nachrichtentext können beliebige Daten anhand von Simple Tokens ergänzt werden.
76

87
## Dokumentation
98
Eine ausführliche Doku findest Du hier: https://www.fenepedia.de/tools/zammad-connector
109

1110
## Schnellstart-Anleitung
12-
1. System > Einstellungen > Zammad-Einstellungen (Host, Benutzer, Passwort)
13-
2. Notification Center > Neues Gateway vom Typ Zammad-API
14-
3. Neue Benachrichtigung (z.B. Formularübergragung)
15-
4. Neue Nachricht erstellen: Gateway = Zammad und Zammad Gruppe hinterlegen
16-
5. Benachrichtigung zuordnen: Formulargenerator > Formular > Benachrichtigung auswählen
11+
1. In Zammad ein neuen Zugriffstoken generieren: User > Profil > Token-Zugriff > Erstellen (Berechtigung: `ticket.agent`)
12+
2. Notification Center > Neues Gateway vom Typ Zammad-API (Host + Token hinterlegen)
13+
3. Neue Benachrichtigung (z. B. Formularübergragung)
14+
4. Neue Nachricht erstellen: Gateway = Zammad
15+
5. Pflichtfelder ausfüllen: E-Mail, Ticket-Betreff, Ticket-Gruppe, Nachrichtentext (Simple Token möglich: `##form_feldname##` )
16+
6. Kunden-Parameter bei Bedarf ergänzen (Empfehlung: `firstname`, `lastname`)
1717

1818
## Zuordnung der Formularfelder
19-
Damit die Zuordnung korrekt funktioniert, müssen die Formularfelder bestimmte Namen haben:
19+
Ab Version 3.0 findet die Zuordnung der Felder über Simple Tokens statt. Anbei noch eine Liste von bekannten Feldnamen für die Kundendaten:
2020
* firstname = Vorname
2121
* lastname = Nachname
22-
* subject = Titel des Tickets
23-
* email = E-Mail-Adresse
24-
* body = Ticket Inhalt
2522
* mobile = Mobilnummer
2623
* phone = Telefonnummer
24+
* fax = Faxnummer
2725
* web = Website
2826
* address = Adresse
29-
* note = Notiz
3027
* department = Abteilung
28+
* street = Straße
29+
* zip = Postleitzahl
30+
* city = Stadt
31+
* Country = Land
32+
* note = Notiz
33+
34+
35+
## Welche Version soll ich installieren?
36+
37+
| Contao Version | PHP Version | NC-Version | Zammad-Erweiterung |
38+
|-----------------|--------------------|--------------------|-------------------------|
39+
| 4.9 \|\| 4.13 | 7.* | 1.6.* | 2.* |
40+
| 4.13.* \|\| 5.* | \>= ^8.1 | 2.* | 3.* |
41+
42+
43+
## Unterstützer:innen
3144

32-
Im Body wird automatisch der *Alias* der Seite ergänzt.
33-
Weitere Felder im Formular werden automatisch am Ende des Tickets dem Body hinzugefügt.
45+
Die Entwicklung der Erweiterung wurde von den folgenden Personen bzw. Unternehmen ermöglicht:
46+
- Fritz Michael Gschwantner | [inspiredminds](https://www.inspiredminds.at/)
47+
- [Alexander Naumov](https://alexandernaumov.de/)
48+
- Christian Feneberg | [Contao Academy](https://contao-academy.de/)
3449

35-
## Credits
36-
* Programmierung: https://alexandernaumov.de/
37-
* Auftraggeber: https://contao-academy.de/

0 commit comments

Comments
 (0)