Zoho CRM Konnektor

Der Zoho CRM Konnektor stellt die Schnittstelle zwischen Zoho CRM und Syncler dar.
Er liegt in drei Versionen vor, die gezielt die API-Versionen 2.1, 6 und 8 adressieren.

  • Abhängig von der gewählten Version stehen unterschiedliche Schemaobjekte und Strukturen zur Verfügung.
  • Die Kommunikation erfolgt standardmäßig über die REST API.

Für die Anmeldung an der API können zwei Verfahren verwendet werden:

  • Self Client
  • Server-based Applications (OAuth Authorization)

⚠️ Für die Version 2.1 steht ausschließlich das Verfahren Self Client zur Verfügung.


Voraussetzungen

Für die Einrichtung des Konnektors müssen bestimmte technische Voraussetzungen erfüllt sein:

  1. Melden Sie sich in Zoho an und rufen Sie die API Konsole auf.
  2. Klicken Sie auf "ADD CLIENT", um eine der beiden Anmeldemethoden einzurichten.
    • Wählen Sie Self Client oder Server-based Applications, abhängig von Ihrer API-Version und gewünschten Zugriffsmethode.
  3. Notieren Sie sich die generierten Client-IDs und Client-Secrets, da diese später in Syncler benötigt werden.

Einrichtung

1. Neues System anlegen

  • Legen Sie in Syncler ein neues System mit dem Konnektor „Zoho CRM“ an.
  • Wählen Sie dabei die passende API-Version (2.1, 6 oder 8).

Die Basis-URLs der API sind bereits in der Maske hinterlegt.
Abhängig von der Zoho-Instanz (z. B. Zoho One) muss die Domain angepasst werden, etwa von .eu auf .com.


2. Authentifizierung konfigurieren

a) Self Client

  • Wechseln Sie in der API-Konsole in den Bereich "Generate Code".
  • Geben Sie die gewünschten Scopes an. (Eine Vorgabe finden Sie im Hilfetext der Syncler-Maske.)
  • Wählen Sie ggf. eine Instanz oder Sandbox und klicken Sie auf "Create".
  • Übernehmen Sie den erzeugten Grant Token in die Syncler-Maske.
  • Nach dem Speichern prüft Syncler den Token und erzeugt eine dauerhaft gültige Anmeldung.

b) Server-based Applications (OAuth Authorization)

  • Tragen Sie in Syncler die Client-ID und das Client-Secret ein.
  • Passen Sie ggf. die Authorization URL an.
  • Hinterlegen Sie eine Redirect URL in Syncler und in der Zoho-API-Konsole, z. B.:
    https://admin.syncler.com/oauth-callback.html
  • Die Scopes sind in Syncler bereits vorbelegt, können aber bei Bedarf angepasst werden.
  • Wechseln Sie nach der Eingabe in die Seite OAuth Authorization und klicken Sie auf Autorisieren.
  • Es öffnet sich ein neues Fenster, in dem Sie sich mit Ihrer Zoho-Anmeldung authentifizieren und den Zugriff bestätigen.
  • Nach dem Speichern wird die Verbindung validiert und dauerhaft gespeichert.

3. Empfehlung

  • Empfohlen wird das OAuth-Verfahren, da hier eine gezielte Freigabe für Syncler erteilt und bei Bedarf wieder entzogen werden kann.
  • Das Self-Client-Verfahren ist unflexibler:
    • Der Client kann nur einmalig definiert werden.
    • Er wird ggf. von mehreren Anwendungen gemeinsam genutzt.
    • Eine gezielte Kontrolle der Berechtigungen ist nicht möglich.

image


Objekte

Die Schemaobjekte des Konnektors beinhalten standardmäßig alle Module von Zoho CRM.

Darüber hinaus sind zusätzliche Objekte verfügbar:

  • E-Mail-Verarbeitung

    • GetEmails → vorhandene E-Mails auslesen
    • AssociateEmails → E-Mails ablegen und zuordnen
    • SendEmails → E-Mails direkt versenden
    • Hinweis: Das Lesen von E-Mails erfordert die Auswahl des übergeordneten Moduls, über Filter mit den Parametern "Related" und "RelatedId"
  • Dateien und Anhänge

    • Attachment → Zugriff und Ablage von Dateianhängen
    • Photo → Zugriff auf das Foto eines Datensatzes
  • Kontaktrollen

    • Contact_Roles → Rollenzuordnung zwischen Kontakten und Deals
  • Gelöschte Datensätze

    • deleted → ermöglicht die Abfrage bereits gelöschter Datensätze

Lesen von Daten

  • Das Lesen von Daten ist grundsätzlich ohne Einschränkungen möglich.
  • Abruf von Änderungen:
    • Kann nicht mit einem Filter kombiniert werden.
    • Nutzen Sie stattdessen den zweiten Filter im Sync.

Filter-Syntax

  • Der Syntax basiert auf einer einfachen Struktur:

(::)

  • Mehrere Bedingungen können mit AND oder OR kombiniert und durch Klammern gruppiert werden:

((::) and (::))

  • ⚠️ Ein leerer Wert (value) führt zu einer Fehlermeldung.
  • Verwenden Sie in diesem Fall einen spezifischen Operator oder einen Dummy-Wert.

Einschränkungen

  • Der Konnektor unterstützt nicht das automatische Filtern des Sync-Status (wegen Konflikten mit Änderungsabfragen).

Abfragen mit COQL

  • Das Lesen von Abfragen wird unterstützt.
  • Syntax basiert auf COQL (CRM Object Query Language).
  • Es ist immer eine WHERE-Bedingung erforderlich.

Schreiben von Daten

  • Das Schreiben von Daten ist für alle Module möglich.
  • Für spezielle Schemaobjekte (z. B. E-Mails, Anhänge) hängt die Schreibfähigkeit vom jeweiligen Objekt ab.
  • Das Löschen von Datensätzen wird unterstützt.

Besonderheiten

  • Durch das Einlesen des Schemas werden automatisch Auswahllisten zu Auswahlfeldern angelegt.

  • Diese können in Transformationen und Validierungen genutzt werden.

  • In den Experteneinstellungen kann die geteilte Verwendung von Access-Tokens aktiviert werden:

  • Access-Tokens stehen dann über Syncler-Parameter auch anderen Syncs zur Verfügung.

  • Dies ist wichtig bei parallelen Ausführungen, da Zoho nur maximal 5 Access-Tokens pro Minute ausgibt.

  • Jeder Sync verwendet eine eigenständige Instanz des Konnektors. Ohne geteilte Tokens kann es zu Limitüberschreitungen kommen.