Bevor Sie mit der Verwendung der API beginnen, sollten Sie sich authentifizieren, um eine Sitzung zu erstellen.
Authentifizierung:
Es gibt 2 Möglichkeiten, die Sitzung zu starten:
- Verwendung Ihres API-Schlüssels, Ihrer Anmelde- und Passwortdaten;
- Verwenden Sie Ihren API-Schlüssel, Login und verschlüsselte Passwortdetails.
Verwendung Ihres API-Schlüssels, Ihrer Login- und Passwortdaten
Hier sollten Sie einfach den Endpunkt POST /session verwenden und den API-Schlüssel, den Sie in den Einstellungen der Plattform erhalten haben, im X-CAP-API-KEY-Header sowie die Login- und API-Schlüssel-Passwortdaten in den Parametern identifier und password angeben. Der Wert des Parameters encryptedPassword sollte false sein.
Verwendung des API-Schlüssels, des Logins und des verschlüsselten Passworts
- Zunächst sollten Sie GET /session/encryptionKey verwenden und den in den Einstellungen der Plattform generierten API-Schlüssel in der Kopfzeile X-CAP-API-KEY angeben. Als Antwort erhalten Sie die Parameter encryptionKey und timeStamp;
- Mit den erhaltenen Parametern encryptionKey und timeStamp sollten Sie Ihr API-Schlüssel-Passwort mit der Verschlüsselungsmethode AES verschlüsseln.
- Gehen Sie zum Endpunkt POST /session, setzen Sie den Wert true für den Parameter encryptedPassword und geben Sie den in den Einstellungen der Plattform erhaltenen API-Schlüssel im X-CAP-API-KEY-Header, die Anmeldung und die zuvor verschlüsselte API-Schlüssel-Passwortinformation in den Parametern identifier und password an
Beim Starten der Sitzung erhalten Sie die Parameter CST und X-SECURITY-TOKEN in den Response-Headern. Diese beiden Token müssen in den Headern jeder von Ihnen gesendeten Anfrage verwendet werden.