V2 vs. V1
De update naar versie 2.0 van de Zoho-API's had een grote invloed op het gebruik van API's en Functies (voorheen aangepaste functies). De werking van de API's is veelal hetzelfde, maar de syntaxis, uitvoer en methoden zijn anders.
Het doel van dit document is om duidelijk het verschil tussen de twee API's aan te geven en gebruikers meer inzicht in versie 2.0 te geven.
Wat is er anders in V2:
- API-aanvragen en -invoerindelingen ondersteunen alleen JSON.
- API's worden geverifieerd met het OAuth 2.0-protocol.
- Er zijn API-namen voor modules, velden en related_lists in versie 2.0, in plaats van weergavelabels zoals in API's van versie 1.0.
- API-aanroeplimieten zijn gebaseerd op een 24-uursperiode, terwijl in V 1.0 de API-aanroeplimiet is gebaseerd op de PST-tijdzone.
- Datum-tijdwaarden worden gegeven in de datum- en tijdnotatie van ISO 8601 (2018-03-28T10:32:45+05:30).
- Alle API-namen die beginnen met $ zijn alleen-lezenkenmerken.
- Wanneer u een record ophaalt, is de respons voor lege velden JSON Null.
- API-namen van modules kunnen worden opgehaald met behulp van 'https://www.zohoapis.com/crm/v2/settings/modules' - URL aanvragen
- Bij API's voor invoegen, bijwerken en upserten kunnen geautomatiseerde acties zoals workflow, goedkeuring en Blueprint voor alle records worden geactiveerd met de sleutel "trigger":["approval",”workflow","blueprint"]
- In API's voor ophalen hebben antwoorden een JSON-object info. Bijvoorbeeld:
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}- page: om de lijst met records van de betreffende pagina's op te halen. De standaardwaarde is 1.
- per_page: om de lijst met beschikbare records per pagina op te halen. De standaardwaarde is 200.
- U kunt more_records gebruiken om te weten te komen of u een extra API-aanroep moet maken om de volgende set records op te halen
- getMyRecords (v1.0-API) kan worden opgehaald met de API searchRecords in versie 2.0
Wijzigingen in veldkenmerken:
| In API-versie 1.0 | Equivalent in API-versie 2.0 |
|---|---|
| {MODULE}ID (bijv. LEADID, CONTACTID, enz.) | ID |
| SMOWNERID | ID gegeven binnen het JSON-object Owner. |
| {MODULE} OWNER (bijv. Lead Owner, Case Owner) | naam gegeven binnen het JSON-object Owner. |
| SMCREATORID | ID gegeven binnen het JSON-object Created_By |
| Gemaakt door | naam gegeven binnen het JSON-object Created_By. |
| MODIFIEDBY | ID gegeven binnen het JSON-object Modified_By |
| Aangepast door | naam gegeven binnen het JSON-object Modified_By. |
Typen veldindelingen:
| Veldtype | V1.0-indeling | V2.0-indeling |
|---|---|---|
| Eén regel | <FL val="Single_Line 1"> <![CDATA[this is single line]]> </FL> | "Single_Line_1": "This is single line", |
| Meerdere regels | <FL val="Multi-Line 1"><![CDATA[this is multi line second line]]></FL> | "Multi_Line_1": "This is \multi line\second line", |
| E-mailadres | <FL val="Email"><![CDATA[email@zoho.com]]><FL> | "Email_1": "email1@email.com", |
| Telefoonnummer | <FL val="Phone 1"><![CDATA[9900000000]]></FL> | "Phone_1": "9900000000", |
| Selectielijst | <FL val="picklist1"><![CDATA[one]]></FL> | "picklist1": "one", |
| Selectielijst voor meerdere selecties | <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/tijd | <FL val="Date/Time 1"><![CDATA[2018-04-07 10:00:00]]></FL> | "Date_Time_1": "2018-04-07T10:00:00+05:30", |
| Getal | <FL val="Number 1"><![CDATA[50000]]></FL> | "Number_1": 50000, |
| Valuta | <FL val="Currency 1"><![CDATA[230000500]]></FL> | "Currency_1": 230000500, |
| Decimaal | <FL val="Decimal 1"><![CDATA[1234.9]]></FL> | "Decimal_1": 1234.9, |
| Percentage | <FL val="Percent 1"><![CDATA[12.3]]></FL> | "Percent_1": 12.3, |
| Lang geheel getal | <FL val="Long Integer 1"><![CDATA[6780000000780000]]></FL> | "Long_Integer_1": "6780000000780000", |
| Selectievakje | <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", |
| Zoeken | <FL val="Lookup 1"><![CDATA[9500495sam]]></FL> | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
| Recordeigenaar | <FL val="SMOWNERID">1386586000000078001</FL> <FL val="Lead Owner"<>![CDATA[BruceWills]]></FL> | "Owner": { "name": "Bruce Wills", "id": "1386586000000078001" }, |
| Lay-out | n.v.t. | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
API-methoden
| Naam methode | Doel |
|---|---|
| getRecords | Alle gebruikersgegevens zoals gespecificeerd in de API-aanvraag ophalen |
| getRecordById | Afzonderlijke records per record-ID ophalen |
| getDeletedRecordIds | De lijst met ID's van verwijderde records uit de prullenbak ophalen |
| insertRecords | Records in de vereiste Zoho CRM-module invoegen |
| updateRecords | De records in Zoho CRM bijwerken of wijzigen |
| getSearchRecordsByPDC | De waarden op basis van vooraf gedefinieerde kolommen zoeken |
| deleteRecords | De geselecteerde records verwijderen |
| convertLead | Leads omzetten in potentieel, account en contactpersoon |
| getRelatedRecords | Records gerelateerd aan een primaire module ophalen |
| getFields | Details van velden die beschikbaar zijn in een module ophalen |
| updateRelatedRecords | Records die gerelateerd zijn aan een andere record bijwerken |
| getUsers | De lijst van gebruikers in uw organisatie ophalen |
| uploadFile | Een bestand aan een record toevoegen |
| delink | De relatie tussen bovenliggende en onderliggende records loskoppelen |
| downloadFile | Een bestand dat is gekoppeld aan een record downloaden |
| deleteFile | Een bestand dat is gekoppeld aan een record verwijderen |
| uploadPhoto | Een foto aan een contactpersoon of lead toevoegen |
| downloadPhoto | De foto van een contactpersoon of lead downloaden |
| deletePhoto | Een foto van een contactpersoon of lead verwijderen |
| getModules | Alle modules van een Zoho CRM-account ophalen |
| searchRecords | De records die overeenkomen met uw zoekcriteria ophalen |