Tutorials

Zoho CRM API-Zugriff einrichten: Eine Schritt-für-Schritt-Anleitung

Melden

Hier ist ein ausführliches Tutorial, wie du den API-Zugriff für Zoho CRM über das OAuth 2.0-Protokoll einrichtest.

Die Zoho CRM API ermöglicht es dir, Daten mit externen Anwendungen zu synchronisieren, Prozesse zu automatisieren und benutzerdefinierte Integrationen zu erstellen. Seit der Abschaltung der alten "AuthTokens" nutzt Zoho ausschließlich den sichereren OAuth 2.0 Standard.

Schritt 1: Zugriff auf die Zoho API Console

Um API-Zugangsdaten zu erstellen, musst du deine Anwendung in der Zoho API Console registrieren.

  1. Gehe zur Zoho API Console (Wichtig: Nutze .eu, wenn dein Account in Europa liegt, oder .com für die USA).
  2. Melde dich mit deinen Zoho-Admin-Zugangsdaten an.
  3. Klicke auf "Add Client" (Client hinzufügen).

Schritt 2: Den passenden Client-Typ wählen

Zoho bietet verschiedene Typen an. Wähle denjenigen, der zu deinem Projekt passt:

  • Java Script: Für browserbasierte Apps.
  • Web Based: Für Server-seitige Anwendungen (PHP, Python, Node.js), die eine Redirect-URL nutzen. (Am häufigsten verwendet).
  • Mobile: Für native Apps (iOS, Android).
  • Self-Client: Ideal für interne Skripte oder Tests (Postman), da du den Autorisierungscode direkt in der Konsole generieren kannst.

Empfehlung für den Anfang: Wähle "Server-based" (Web-basiert).

Schritt 3: Client-Details registrieren

Gib die erforderlichen Informationen ein:

  1. Client Name: Ein Name deiner Wahl (z.B. "Meine Web-App").
  2. Homepage URL: Die URL deiner Website.
  3. Authorized Redirect URIs: Dies ist die URL, an die Zoho den Autorisierungscode sendet. Wenn du nur testen willst, kannst du https://www.google.de oder eine lokale URL nutzen.
  4. Klicke auf Create.

Du erhältst nun zwei sehr wichtige Informationen:

  • Client ID
  • Client Secret

Speichere diese sicher ab!

Schritt 4: Scopes definieren

Ein "Scope" legt fest, worauf deine API zugreifen darf. Für Zoho CRM beginnen Scopes immer mit ZohoCRM..

Beispiele:

  • ZohoCRM.modules.ALL: Vollzugriff auf alle Module (Kontakte, Leads, etc.).
  • ZohoCRM.modules.leads.READ: Nur Lesezugriff auf das Leads-Modul.
  • ZohoCRM.users.READ: Zugriff auf Benutzerinformationen.

Schritt 5: Den Authorization Code (Grant Token) generieren

Bevor du Daten abrufen kannst, musst du die Erlaubnis des Nutzers einholen.

Bei "Self-Client" (für schnelle Tests):

  1. Klicke beim erstellten Client auf den Reiter "Generate Code".
  2. Gib den gewünschten Scope ein (z.B. ZohoCRM.modules.ALL).
  3. Wähle eine Zeitdauer (z.B. 10 Min).
  4. Klicke auf Generate. Du erhältst einen Code (Grant Token).

Bei "Web-based" (für echte Apps): Du musst den Nutzer zu folgender URL leiten: https://accounts.zoho.eu/oauth/v2/auth?scope=ZohoCRM.modules.ALL&client_id=DEINE_CLIENT_ID&response_type=code&access_type=offline&redirect_uri=DEINE_REDIRECT_URI

Schritt 6: Access- und Refresh-Token generieren

Mit dem Grant Token aus Schritt 5 musst du nun die eigentlichen Token anfordern. Dies geschieht über einen POST-Request.

Endpunkt: https://accounts.zoho.eu/oauth/v2/token

Parameter im Body (x-www-form-urlencoded):

  • grant_type: authorization_code
  • client_id: Deine Client ID
  • client_secret: Dein Client Secret
  • redirect_uri: Deine Redirect URI
  • code: Der Grant Token aus Schritt 5

Die Antwort enthält:

  1. access_token: Gültig für eine Stunde (wird für jeden API-Call benötigt).
  2. refresh_token: Lebenslang gültig (wird genutzt, um neue Access Tokens zu generieren).
  3. api_domain: Die URL, die du für API-Anrufe nutzen musst (z.B. https://www.zohoapis.eu).

Schritt 7: Den ersten API-Call machen

Du kannst nun Daten abrufen. Setze den access_token in den Header deiner Anfrage.

Beispiel: Alle Leads abrufen

  • Methode: GET
  • URL: https://www.zohoapis.eu/crm/v3/Leads
  • Header:
    • Authorization: Zoho-oauthtoken DEIN_ACCESS_TOKEN

Wichtige Hinweise für die Entwicklung

  1. Refresh Token: Da der access_token nach 60 Minuten abläuft, muss dein Skript programmiert sein, mit dem refresh_token automatisch einen neuen access_token zu generieren, sobald eine Fehlermeldung (401 Unauthorized) erscheint.
  2. API Limits: Zoho hat tägliche Limits für API-Anrufe, abhängig von deiner Edition.
  3. Regionen: Achte darauf, ob dein Account auf .eu, .com, .in oder .com.cn läuft. Die Endpunkte müssen exakt übereinstimmen.
  4. Sicherheit: Gib dein Client Secret niemals in Client-seitigem Code (Javascript im Browser) preis. Nutze dafür immer eine Server-Bridge.

Glückwunsch! Du hast nun den Zugriff auf die Zoho CRM API erfolgreich eingerichtet.

0