Skip to main content

REST-API-Demo

Die offizielle technische Dokumentation der REST-Services finden Sie direkt auf dem Server unter https://demo-restapi.cursor.de/rest/doc/v1/services/. Um den Einstieg in die Verwendung der REST-Services zu erleichtern, haben wir im Folgenden einige konkrete Beispiele zusammengestellt. Diese können Sie auch gegen das von CURSOR zur Verfügung gestellte Demo-System absetzen. Bitte beachten Sie vorab die unten aufgeführten technischen Informationen.

Authentifizierung

Alle CURSOR REST-Endpunkte benötigen eine gültige Authentifizierung. Als Methode wird Basic Auth genutzt. Zur Anmeldung kann entweder der Benutzername und Passwort oder ein gültiges Sessiontoken genutzt werden.

Bitte beachten Sie: Services, die einen Workspace bereitstellen, sollten immer mit Sessiontoken verwendet werden. Ansonsten kann bei weiteren Aufrufen nicht mehr auf den Workspace zugegriffen werden. Wird ein Sessiontoken genutzt muss dieses sowohl als Benutzername als auch als Passwort gesetzt werden. Ein gültiges Sessiontoken erhalten Sie durch das Ansprechen des Endpunkts rest/api/session/v1/session.

Die meisten der hinterlegten Beispielaufrufe verwenden zur Authentifizierung jedoch Benutzername und Passwort, damit sie direkt ohne weitere Modifikation gegen das Demo-System ausführbar sind. In produktiven Umgebungen bietet sich die Verwendung eines Sessiontokens an.

Verwendung

Die bereitgestellte Demo wird mit dem Insomnia REST Client (https://insomnia.rest/) generiert. Die konkreten REST-Aufrufe können aber auch mit jedem anderen beliebigen HTTP-Clients abgesetzt werden.

Insomnia REST Client

Sollten Sie ebenfalls den Insomnia REST Client nutzen, können Sie das Projektfile unter https://www.cursor.de/demo/restapi/insomnia.json herunterladen. Die Anmelde- und Serverdaten können einmalig im Environment Image 2 verwaltet werden. Die Beispielaufrufe verwenden dann die dort hinterlegten Daten.

Andere HTTP Clients

Nutzen Sie andere Clients müssen die Werte für Server und Authentifizierung pro Beispielaufruf entsprechend korrigiert werden, wenn der Aufruf gegen ein anderes CURSOR-CRM als das Demo-System abgesetzt werden soll.

Testen Sie live unsere REST-API

Jetzt REST-API-Demo starten ...