Sprinklr (v1)

Diese Anleitung erklärt Schritt für Schritt, wie du in Sprinklr einen API Key (Client ID & Secret) im Developer Portal erzeugst und über OAuth 2.0 (Authorization Code Flow) ein Access Token (Bearer Token) für deine Umgebung generierst, um die Sprinklr Web APIs erfolgreich zu nutzen.

---

🧩 Voraussetzungen

Bevor du beginnst, stelle sicher, dass du:

• Aktive Zugangsdaten für beide Plattformen besitzt:

  • Sprinklr UI-Plattform (Produktiv-UI)

  • Sprinklr Developer Portal: http://developer.sprinklr.com/

• Berechtigungen hast, um Apps im Developer Portal zu erstellen

• Eine gültige Redirect/Callback-URL registriert hast

• Optional: Zugriff auf Postman oder ein anderes Tool für HTTP-Requests

Die Anmeldung für die Sprinklr UI unterscheidet sich von der des Developer Portals. Du benötigst beide Logins, um API Key und Token erfolgreich zu generieren.

---

📚 Begriffsklärung: Was ist die „Register Callback URL“?

Die Callback-/Redirect-URL ist die Zieladresse, zu der Sprinklr nach der Benutzerfreigabe zurückleitet und den Authorization Code als Query-Parameter code anhängt. Sie muss exakt mit der im Developer Portal registrierten URL übereinstimmen – inklusive Protokoll, Pfad und ggf. Trailing Slash.

Typische Beispiele:

• Eigene Anwendung: https://app.example.com/oauth/callback

• Für Tests in Postman: https://oauth.pstmn.io/v1/callback

Wenn die Redirect-URL nicht exakt übereinstimmt, schlägt der OAuth-Flow mit einem Redirect/Invalid Client Error fehl.

---

⚙️ Schritt-für-Schritt-Anleitung

1. API Key (Client ID & Secret) generieren

1. Melde dich im Sprinklr Developer Portal an: 👉 http://developer.sprinklr.com/

2. Navigiere zu MY ACCOUNT → CREATE A NEW APP.

3. Fülle das Formular Register an Application aus:

   • Name, Beschreibung, Kontakt

   • Register Callback URL (deine Redirect-URL, siehe oben)

4. Klicke auf Register Application.

5. Notiere dir die generierten Werte:

   • Client ID (API Key)

   • Client Secret

Du findest beide Werte später unter MY ACCOUNT im Developer Portal.

Speichere Client ID & Secret sicher (z. B. in einem Secrets-Manager) und teile sie niemals öffentlich.

2. Eigene Sprinklr-Umgebung ermitteln

Da Tokens umgebungsspezifisch sind, musst du zuerst herausfinden, wo deine Instanz läuft:

1. Melde dich in der Sprinklr UI-Plattform an.

2. Rechtsklick → Seitenquelltext anzeigen.

3. Suche (Strg/Cmd + F) nach sentry-environment.

4. Notiere die Umgebung, z. B.:

   • app, prod0, prod2, etc.

Diese Information brauchst du für den richtigen API-Host.

Ein Token, das in Umgebung A generiert wurde, funktioniert nicht in Umgebung B!

3. Benutzerfreigabe (Authorization Code holen)

Rufe folgende URL im Browser auf (Login nicht zwingend erforderlich): https://api2.sprinklr.com/{{env}}/oauth/authorize?client_id={{CLIENT_ID}}&response_type=code&redirect_uri={{REDIRECT_URI}}

Parameter:

Parameter	Beschreibung
client_id	Deine Client ID (API Key)
response_type	Immer code
redirect_uri	Exakt registrierte Callback-URL

1. Bestätige die Berechtigungsanfrage und melde dich ggf. mit deinen Sprinklr UI-Zugangsdaten an.

2. Nach erfolgreicher Freigabe wirst du auf die Redirect-URL weitergeleitet, z. B.: https://www.google.com?code=123456789

3. Kopiere den erhaltenen Authorization Code (code=...).

Der Authorization Code ist nur 10 Minuten gültig. Wenn du den nächsten Schritt nicht rechtzeitig ausführst, starte den Prozess erneut.

4. Access Token generieren (Token Endpoint)

Sende nun einen POST-Request an den Token-Endpunkt deiner Umgebung.

Beispiel-URL: https://api2.sprinklr.com/{{env}}/oauth/token?client_id={{CLIENT_ID}}&client_secret={{CLIENT_SECRET}}&redirect_uri={{REDIRECT_URI}}&grant_type=authorization_code&code={{AUTH_CODE}}

Header: Content-Type: application/x-www-form-urlencoded

Beispiel mit cURL:

curl -X POST \
"https://api2.sprinklr.com/{{env}}/oauth/token?client_id={{CLIENT_ID}}&client_secret={{CLIENT_SECRET}}&redirect_uri={{REDIRECT_URI}}&grant_type=authorization_code&code={{AUTH_CODE}}" \
-H "Content-Type: application/x-www-form-urlencoded"

Beispiel-Response:

{
  "access_token": "[token]",
  "refresh_token": "[token]",
  "token_type": "Bearer",
  "expires_in": 2591999
}

Du kannst diese Anfrage bequem in Postman ausführen:

• Methode: POST

• Header: Content-Type: application/x-www-form-urlencoded

• Body leer lassen (Parameter sind in der Query)

5. Token verwenden & erneuern

Authentifizierung bei API-Aufrufen:

Authorization: Bearer {{ACCESS_TOKEN}}

Refresh Token verwenden (wenn Access Token abläuft):

curl -X POST \
"https://api2.sprinklr.com/{{env}}/oauth/token?client_id={{CLIENT_ID}}&client_secret={{CLIENT_SECRET}}&grant_type=refresh_token&refresh_token={{REFRESH_TOKEN}}" \
-H "Content-Type: application/x-www-form-urlencoded"

Tokens bleiben gültig, solange das Passwort des Sprinklr-Benutzers unverändert bleibt. Nach einer Passwortänderung kannst du mit dem Refresh Token ein neues Access Token anfordern.

🔒 Sicherheitshinweise

• Bewahre Client Secret, Access Token und Refresh Token sicher auf.

• Verwende ausschließlich HTTPS für API-Aufrufe.

• Nutze einen Secrets-Manager statt Klartextdateien.

• Checke niemals Zugangsdaten in öffentliche Repositories ein.

---

🧾 Schnellreferenz (Parameterübersicht)

Kategorie	Parameter	Beschreibung
Authorize-URL	client_id	Client ID (API Key)
	response_type	Immer code
	redirect_uri	Registrierte Callback-URL
Token-URL (Authorization Code)	client_id, client_secret	Deine App-Zugangsdaten
	redirect_uri	Muss mit Authorize-Phase übereinstimmen
	grant_type	authorization_code
	code	Authorization Code (gültig ≤ 10 Minuten)
Token-URL (Refresh)	grant_type	refresh_token
	refresh_token	Erneuerungs-Token aus erster Antwort

---

✅ Ergebnis

Nach Abschluss dieser Schritte hast du erfolgreich:

• Client ID & Secret im Sprinklr Developer Portal erstellt

• Ein gültiges Access (Bearer) Token & Refresh Token generiert

• Die korrekte Basis-URL deiner Umgebung identifiziert

Du kannst nun autorisierte Anfragen an die Sprinklr Web APIs senden und deine Integrationen sicher betreiben!