REST-API verwenden
Einen neuen REST-Endpunkt anlegen in WEB CONNECT
- Klicken Sie die Schaltfläche »Neuer Endpunkt« an.
Damit wird eine neue leere Zeile angelegt, in der Sie einen Endpunkt konfigurieren können.
Im abgebildeten Beispiel wird der Endpunkt »Support-Tickets« benannt und bezieht sich auf die Tabelle »Support-Tickets«. Durch den gesetzten Filter werden nur die Tickets ausgegeben, die von Bernd Schlegel stammen. Benutzer des Endpunktes haben das Recht, diese Datensätze zu lesen, zu schreiben und zu löschen.
Sie können die Zugriffsrechte bis auf einzelne Felder differenzieren.
- Klicken Sie das kleine Zeichen »+« links neben einem Eintrag in der Spalte »Endpunktname« an.
Es öffnet sich eine weitere Unterauswahl, in der Sie Rechte auf einzelne Felder ausgewählter Datentabellen vergeben können.
Die folgenden beiden Auswahlmöglichkeiten funktionieren analog zueinander:
In dieser Abbildung werden einzelnen Feldern der Support-Tabelle bestimmte Rechte zugewiesen.
- Haben Sie eine Zeile fertiggestellt, klicken Sie in den leeren Bereich im unteren Teil des Dialoges, um eine weitere Zeile anzulegen.
Analog zu unserem dargestellten Beispiel mit einer Zusatztabelle können Sie API-Endpunkte auch für »freie Tabellen« und deren verknüpfte Tabellen erstellen. So bspw. für die freie Tabelle »Immobilien«.
Endpunkte exportieren/importieren
Sie haben die Möglichkeit, die von Ihnen erstellten Endpunkte zu exportieren oder bereits bestehende Endpunkte zu importieren. Dies erleichtert Ihnen die Endpunkteverwaltung, sodass Sie bspw. im cobra EVENT MODUL nicht erneut alle Endpunkte händisch anlegen müssen. Der Export oder Import geschieht via XML-Datei.
Funktions-Endpunkte zur Rufnummernsuche
Sie können mit der Option »Funktions-Endpunkte« die Rufnummernsuche einrichten, die Ihnen ermöglicht über eine Rufnummer oder einen Teil der Rufnummer die zugehörige Adresse aus Ihrer cobra Datenbank abzufragen. Hierzu müssen Sie diese Art von Endpunkt aktivieren und das gewünschte Anzeigeformat bzw. die gewünschten Felder festlegen.
Der Endpunkt zur Rufnummersuche heißt »PhoneSearch« und lässt sich nicht umbenennen.
Funktions-Endpunkte zur E-Mail-Suche
Sie können mit der Option »Funktions-Endpunkte« die E-Mail-Suche einrichten, die Ihnen ermöglicht über eine E-Mail-Adresse die zugehörige Adresse aus Ihrer cobra Datenbank abzufragen. Hierzu müssen Sie diese Art von Endpunkt aktivieren und die gewünschten Felder festlegen.
Der Endpunkt zur E-Mail-Suche heißt »MailSearch« und lässt sich nicht umbenennen.
Funktions-Endpunkte für SQL-Befehle
Sie können mit der Option »Funktions-Endpunkte« einen Endpunkt anlegen, um SQL-Befehle auszuführen. Dies eröffnet Ihnen zahlreiche Möglichkeiten bspw. ein Warenwirtschaftssystem anzusteuern oder Wartungsaufgaben anzustoßen. Um diese Funktion nutzen zu können:
- Vergeben Sie für den Endpunkt einen relevanten Namen.
- Wählen Sie die relevante Datenbank aus.
- Tragen Sie den gewünschten SQL-Befehl ein.
Der Endpunkt zur Ausführung von SQL-Befehlen heißt »Sql« und lässt sich nicht umbenennen.
Wir empfehlen Ihnen den Zugriff auf die Funktions-Endpunkte der SQL-Befehle über einen API-Key einzuschränken, um Ihre Datenbank vor möglichen Anwenderfehlern zu schützen.
Funktions-Endpunkte zur Ausführung von Anwendungen
Sie können mit der Option »Funktions-Endpunkte« einen Endpunkt anlegen, um Anwendungen zu starten. Dies eröffnet viele Möglichkeiten, z.B. Skripte oder Stapelverarbeitungsdateien auszuführen. Um diese Funktion nutzen zu können:
- Vergeben Sie für den Endpunkt einen relevanten Namen.
- Wählen Sie die relevante Datei der Anwendung aus.
Der Endpunkt zur Ausführung von Anwendungen heißt »Scripts« und lässt sich nicht umbenennen.
Funktions-Endpunkte zur cobra Benutzerverwaltung
Sie können mit der Option »Funktions-Endpunkte« einen Endpunkt erstellen, um mit der cobra Benutzerverwaltung zu interagieren. Mit diesem Endpunkt können Sie Daten der cobra Benutzerverwaltung von Benutzern und Gruppen auslesen oder bearbeiten. Um diese Funktion nutzen zu können:
- Aktivieren Sie die Checkbox »Benutzer- und Gruppen-Endpunkte aktiv«.
- Entscheiden Sie, ob ein Lesezugriff oder auch ein Schreibzugriff möglich sein soll.
- Aktiveren Sie ggf. die Checkbox »Passwörter über API änderbar«, falls Sie die Passwörter der relevanten Benutzer über den Endpunkt bearbeiten möchten.
Der Endpunkt zur Interaktion mit der cobra Benutzerverwaltung heißt »Usermanagement« und lässt sich nicht umbenennen.