Version 2 im Vergleich zu Version 1
Die Aktualisierung von Zoho-APIs auf Version 2.0 hat sich stark auf die Verwendung von APIs und Funktionen (vormals benutzerdefinierten Funktionen) ausgewirkt. Die Funktionsweise der APIs ist in der Regel die gleiche, aber Syntax, Ausgabe und Methoden sind unterschiedlich.
Der Zweck dieses Dokuments ist es, den Unterschied zwischen den beiden APIs deutlich herauszustellen und Benutzern ein besseres Verständnis der Version 2.0 zu vermitteln.
Was in Version 2 anders ist:
- Als Ausgabe- und Eingabeformat der API wird nur JSON unterstützt.
- APIs werden per OAuth 2.0-Protokoll authentifiziert.
- Für Module, Felder und verknüpfte Listen gibt es in Version 2.0 API-Namen anstatt der Anzeigebezeichnungen wie in Version 1.0.
- API-Aufruflimits beruhen auf einem rollenden 24-stündigen Zeitfenster, während das Aufruflimit in Version 1.0 auf der PST-Zeitzone beruht.
- Die Werte für Datum und Zeit werden im ISO 8601-Format angegeben (2018-03-28 T10:32:45+05:30).
- Alle API-Namen, die mit $ beginnen, sind schreibgeschützte Attribute.
- Wenn Sie für einen Datensatz GET aufrufen, ist die Antwort für leere Felder JSON Null.
- API-Namen für Module können über "https://www.zohoapis.com/crm/v2/settings/modules" – Anfrage-URL abgerufen werden.
- Bei APIs zum Einfügen, Aktualisieren und Einfügen/Aktualisieren („Upsert“) können automatisierte Aktionen wie Workflow, Genehmigung und Blueprint für alle Datensätze über den Schlüssel "trigger": ["approval", "workflow", "blueprint"] ausgelöst werden.
- In GET-APIs haben die Antworten ein info-JSONObject. Bsp.:
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}- page: Liste der Datensätze von den betreffenden Seiten abrufen. Standardwert ist 1.
- per_page: Liste der pro Seite verfügbaren Datensätze abrufen. Standardwert ist 200.
- more_records gibt an, ob der Aufruf des nächsten Datensatzes über einen zusätzlichen API-Aufruf erfolgen soll
- getMyRecords(v1.0 API) kann in Version 2.0 per searchRecords-API abgerufen werden
Änderungen der Feldattribute:
| In API-Version 1.0 | Äquivalent in API-Version 2.0 |
|---|---|
| {MODULE}ID (Bsp. LEADID,CONTACTID usw.) | id |
| SMOWNERID | Die ID wird innerhalb des JSONObject Owner angegeben. |
| {MODULE} OWNER (Bsp. Lead-Besitzer, Fallbesitzer) | Der Name wird innerhalb des JSONObject Owner angegeben. |
| SMCREATORID | Die ID wird innerhalb des JSONObject Created_By angegeben. |
| Erstellt von | Der Name wird innerhalb des JSONObject Created_By angegeben. |
| MODIFIEDBY | Die ID wird innerhalb des JSONObject Modified_By angegeben. |
| Geändert von | Der Name wird innerhalb des JSONObject Modified_By angegeben. |
Feldformat-Typen:
| Feldtyp | Format in Version 1.0 | Format in Version 2.0 |
|---|---|---|
| Einzelne Zeile | <FL val="Single_Line 1"> <![CDATA[this is single line]]> </FL> | "Single_Line_1": “This is single line”, |
| Mehrere Zeilen | <FL val="Multi-Line 1"><![CDATA[this is multi line second line]]></FL> | "Multi_Line_1": "This is \multi line\second line", |
| <FL val="Email"><![CDATA[email@zoho.com]]><FL> | "Email_1": "email1@email.com", | |
| Telefon | <FL val="Phone 1"><![CDATA[9900000000]]></FL> | "Phone_1": "9900000000", |
| Auswahlliste | <FL val="picklist1"><![CDATA[one]]></FL> | "picklist1": "one", |
| Auswahlliste mit Mehrfachauswahl | <FL val="Multi-Select 1"><![CDATA[Option1;Option 2]]></FL> | "Multi_Select_1": [ "Option 1", "Option 2" ] |
| Datum | <FL val="Date 1"><![CDATA[2018-03-29]]></FL> | "Date_1": "2018-03-29", |
| Datum/Uhrzeit | <FL val="Date/Time 1"><![CDATA[2018-04-07 10:00:00]]></FL> | "Date_Time_1": "2018-04-07T10:00:00+05:30", |
| Nummer | <FL val="Number 1"><![CDATA[50000]]></FL> | "Number_1": 50000, |
| Währung | <FL val="Currency 1"><![CDATA[230000500]]></FL> | "Currency_1": 230000500, |
| Dezimalzahl | <FL val="Decimal 1"><![CDATA[1234.9]]></FL> | "Decimal_1": 1234,9, |
| Prozentangabe | <FL val="Percent 1"><![CDATA[12.3]]></FL> | "Percent_1": 12,3, |
| Lange Ganzzahl | <FL val="Long Integer 1"><![CDATA[6780000000780000]]></FL> | "Long_Integer_1": "6780000000780000", |
| Kontrollkästchen | <FL val="Checkbox 1"><![CDATA[true]]></FL> | "Checkbox_1": true, |
| URL | <FL val="URL 1"><![CDATA[https://www.zoho.com]]></FL> | "URL_1": "https://www.zoho.com", |
| Suche | <FL val="Lookup 1"><![CDATA[9500495sam]]></FL> | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
| Datensatzbesitzer | <FL val="SMOWNERID">1386586000000078001</FL> <FL val="Lead Owner"<>![CDATA[BruceWills]]></FL> | "Owner": { "name": "Bruce Wills", "id": "1386586000000078001" }, |
| Layout | K. A. | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
API-Methoden
| Name der Methode | Zweck |
|---|---|
| getRecords | Für alle in der API-Anfrage angegebenen Benutzer die Daten abrufen |
| getRecordById | Einzelne Datensätze nach Datensatz-ID abrufen |
| getDeletedRecordIds | Liste der IDs gelöschter Datensätze aus Papierkorb abrufen |
| insertRecords | Datensätze in das erforderliche Zoho CRM-Modul einfügen |
| updateRecords | Datensätze in Zoho CRM aktualisieren oder ändern |
| getSearchRecordsByPDC | Die Werte basierend auf vordefinierten Spalten durchsuchen |
| deleteRecords | Die ausgewählten Datensätze löschen |
| convertLead | Interessenten in Deals, Konten und Kontakte umwandeln |
| getRelatedRecords | Mit einem primären Modul verknüpfte Datensätze abrufen |
| getFields | Informationen aus in einem Feld verfügbaren Informationen abrufen |
| updateRelatedRecords | Mit einem anderen Datensatz verknüpfte Datensätze aktualisieren |
| getUsers | Die Liste der Benutzer in Ihrem Unternehmen abrufen |
| uploadFile | Eine Datei an einen Datensatz anhängen |
| delink | Die Beziehung zwischen übergeordneten und untergeordneten Datensätzen auflösen |
| downloadFile | Eine an einen Datensatz angehängte Datei herunterladen |
| deleteFile | Eine an einen Datensatz angehängte Datei löschen |
| uploadPhoto | Foto zu einem Kontakt oder Lead hinzufügen |
| downloadPhoto | Das Foto von einem Kontakt oder Lead herunterladen |
| deletePhoto | Ein Foto von einem Kontakt oder Lead löschen |
| getModules | Alle Module vom Zoho CRM-Konto abrufen |
| searchRecords | Die Datensätze abrufen, die Ihren Suchkriterien entsprechen |