Functies - Integratietaken
Zoals u misschien al weet, heeft de update naar API's van versie 2.0 een grote rol gespeeld bij het gebruik van aangepaste functies, die nu eenvoudig "Functies" worden genoemd. Deze handleiding helpt u bij het gebruik van integratietaken voor functies op basis van de nieuwe API's.
Aan de slag
Om te beginnen is het basisverschil tussen versie 1.0 en 2.0 van Zoho API's dat veldnamen worden gebruikt in 1.0 en API-namen in 2.0.
De API-namen van modules ophalen:
- Ga naar Instellen > Developer Space > API's > CRM API > API-namen.
- De API-namen van de modules worden vermeld op het tabblad API-namen.
De API-namen van velden in modules ophalen:
- Ga naar Instellen > Developer Space > API's > CRM API > API-namen.
- Klik op een modulenaam. Bijvoorbeeld: Leads
- Het tabblad API-naam bevat de API-namen van velden. Deze velden moeten worden gebruikt in de code en NIET in de namen op het tabblad Veldlabel.
Records ophalen
Records met informatie kunnen worden opgehaald uit meerdere ondersteunde modules van CRM. U kunt de records ophalen met de taak zoho.crm.getRecords().
Syntaxis (met API's van versie 2.0):
<response>=zoho.crm.getRecords(<module_name>, [<page>],[<perPage>], {<optionalDataMap>}, <connections>);
| Parameters | Beschrijving |
|---|---|
| <response> | De lijst met records die voldoen aan de ophaalcriteria. |
| <module_name> | De naam van de module waarvan de record moet worden opgehaald. Ondersteunde modules zijn: Leads, Deals, Producten, Contactpersonen, Campagnes, Leveranciers, Accounts, Cases, Offertes, Salesorders, Inkooporders, Facturen en Aangepast. |
| <page> (optioneel) | Hiermee wordt de lijst met records op basis van pagina's opgehaald. Deze heeft het gegevenstype NUMMER. Standaard - 1. |
| <perPage> (optioneel) | Hiermee wordt de lijst met beschikbare records per pagina opgehaald. Deze heeft het gegevenstype NUMMER. Standaard - 200. |
| <optionalDataMap> | Deze optie wordt gebruikt om de lijst met records op te halen met andere parameters dan page en per_page. |
| <connections> | Hiermee worden de connectors weergegeven die bij de functie horen. Het gegevenstype is STRING. |
Voorbeeld van invoergegevens:
resp = zoho.crm.getRecords("Leads",1,20,{"converted":"true"});
Let op:
- In het bovenstaande voorbeeld is "converted" een optionalDataMap.
Syntaxis (met API's van versie 1.0):
<response>=zoho.crm.v1.getRecords(<module_name>, [<from_index>],[<to_index>]);
Record ophalen op id
Een lijst met records ophalen is één ding, maar wat als u details van een specifieke record wilt ophalen? U kunt de taak zoho.crm.getRecordById() gebruiken om de informatie over een bepaalde record op te halen.
Syntaxis (met API's van versie 2.0):
<response>=zoho.crm.getRecordById(<module_name>, <record_ID>, <connections>);
| Parameters | Beschrijving |
|---|---|
| <response> | Het antwoord dat als een MAP wordt geretourneerd. |
| <module_name> | De naam van de module waarvan de record moet worden opgehaald. Ondersteunde modules zijn: Leads, Deals, Producten, Contactpersonen, Campagnes, Leveranciers, Accounts, Cases, Offertes, Salesorders, Inkooporders, Facturen en Aangepast. |
| <record_ID> | De id van de record die moet worden opgehaald. Deze heeft het gegevenstype NUMMER. |
| <connections> | Hiermee worden de connectors weergegeven die bij de functie horen. Het gegevenstype is STRING. |
Voorbeeld van invoergegevens:
resp = zoho.crm.getRecordById("Leads", 2938383000000392001);
Syntaxis (met API's van versie 1.0):
<response>=zoho.crm.v1.getRecordById(<module_name>, <record_ID>);
Een record maken
Stel de functies zo in dat records automatisch worden gemaakt op basis van bepaalde acties. Bijvoorbeeld: u kunt de functie activeren om een record in taken te maken bij het wijzigen van de status van een lead. De taak zoho.crm.create() wordt gebruikt om records te maken.
Syntaxis (met API's van versie 2.0):
<variable>=zoho.crm.create(<module_name>,{<dataMap>}, {<optionalDataMap>}, <connections>);
| Parameters | Beschrijving |
|---|---|
| <response> | Het antwoord dat als een MAP wordt geretourneerd. |
| <module_name> | De naam van de module waarvan de record moet worden opgehaald. Ondersteunde modules zijn: Leads, Deals, Producten, Contactpersonen, Campagnes, Leveranciers, Accounts, Cases, Offertes, Salesorders, Inkooporders, Facturen en Aangepast. |
| <dataMap> | De naam van de velden in de module die moeten worden opgegeven bij het maken van de record. Bijvoorbeeld: {"Last_name":"Zoho CRM"} |
| <optionalDataMap> | Vertegenwoordigt alle gegevenstoewijzingen, behalve ingevoerde JSON. |
| <connections> | Hiermee worden de connectors weergegeven die bij de functie horen. Het gegevenstype is STRING. |
Voorbeeld van invoergegevens:
data = Map();
data.putAll({"Last_Name":"Bruce Wills", "Company":"Zylker"});
optionalMap = Map();
optionalMap.put("trigger", ["workflow","approval", "blueprint"]); // "trigger" leeg [] doorgeven om workflow niet uit te voeren
resp = zoho.crm.create("Leads", data, optionalMap);
Voorbeeldrespons:
{"Modified_Time":"2018-03-26T14:33:01+05:30","Modified_By":{"name":"Ben","id":"2938383000000132011"},"Created_Time":"2018-03-26T14:33:01+05:30","id":"2938383000000389001","Created_By":{"name":"Ben","id":"2938383000000132011"}}
Syntaxis (met API's van versie 1.0):
<variable>=zoho.crm.v1.create(<module_name>,{<field_values>});
Bulkrecords maken
Stel de functies zo in dat records automatisch worden gemaakt op basis van bepaalde acties. Bijvoorbeeld: u kunt de functie activeren om meerdere records te maken, in onder meer contactpersonen, accounts, taken en deals wanneer u een lead omzet in een contactpersoon. De taak zoho.crm.bulkCreate() wordt gebruikt om records te maken.
Syntaxis (met API's van versie 2.0):
<variable>=zoho.crm.bulkCreate(<module_name>,[record1, record2]);
| Parameters | Beschrijving |
|---|---|
| <response> | Het antwoord dat als een MAP wordt geretourneerd. |
| <module_name> | De naam van de module waarvan de record moet worden opgehaald. Ondersteunde modules zijn: Leads, Deals, Producten, Contactpersonen, Campagnes, Leveranciers, Accounts, Cases, Offertes, Salesorders, Inkooporders, Facturen en Aangepast. |
| [record1, record2] | De lijst die de informatie bevat over de records die worden gemaakt. |
Voorbeeld van invoergegevens:
resp = zoho.crm.bulkCreate("Leads", [{"Last_Name":"Deborah"},{"Last_Name":"James"}], {"trigger":["workflow","blueprint","approval"]});
Een record bijwerken
Het zal vaak gebeuren dat u records moet bijwerken. U kunt bijvoorbeeld de bestaande informatie bewerken en aanvullende informatie toevoegen door de taak zoho.crm.update() in te stellen, waarmee automatisch een record wordt bijgewerkt op basis van het geprogrammeerde scenario.
Syntaxis (met API's van versie 2.0):
<response>=zoho.crm.update(<module_name>, <record_ID>, <dataMap>, {<optionalDataMap>}, <connections>);
| Parameters | Beschrijving |
|---|---|
| <response> | Het antwoord dat als een MAP wordt geretourneerd. |
| <module_name> | De naam van de module waarvan de record moet worden opgehaald. Ondersteunde modules zijn: Leads, Deals, Producten, Contactpersonen, Campagnes, Leveranciers, Accounts, Cases, Offertes, Salesorders, Inkooporders, Facturen en Aangepast. |
| <record_ID> | De ID van de record die moet worden bijgewerkt. Deze heeft het gegevenstype NUMMER. |
| <dataMap> | Sleutel. Waardeparen met bijgewerkte recordgegevens. |
| <optionalDataMap> | Vertegenwoordigt alle gegevenstoewijzingen, behalve ingevoerde JSON. |
| <connections> | Hiermee worden de connectors weergegeven die bij de functie horen. Het gegevenstype is STRING. |
Voorbeeld van invoergegevens:
resp = zoho.crm.update("Leads", 2938383000000392001, {"Company":"Zylker Corp"});
Voorbeeldrespons:
{"Modified_Time":"2018-03-26T15:17:39+05:30","Modified_By":{"name":"Ben","id":"2938383000000132011"},"Created_Time":"2018-03-26T14:39:28+05:30","id":"2938383000000392001","Created_By":{"name":"Ben","id":"2938383000000132011"}}
Syntaxis (met API's van versie 1.0):
<response>=zoho.crm.v1.updateRecord(<module_name>, <record_ID>, <New values as map object>);
Een record zoeken
Zoek specifieke records door de criteria voor de zoekactie op te geven. De gezochte records kunnen worden gebruikt om overal acties uit te voeren. Voor het zoeken van een record moeten de modulenaam en de zoekcriteria worden opgegeven.
Syntaxis (met API's van versie 2.0):
<response>=zoho.crm.searchRecords(<module_name>, <criteria>, [<page>],[<perPage>], <connections>);
| Parameters | Beschrijving |
|---|---|
| <response> | De lijst met records die voldoen aan de ophaalcriteria. |
| <module_name> | De naam van de module waarvan de record moet worden opgehaald. Ondersteunde modules zijn: Leads, Deals, Producten, Contactpersonen, Campagnes, Leveranciers, Accounts, Cases, Offertes, Salesorders, Inkooporders, Facturen en Aangepast. |
| <criteria> | De voorwaardelijke instructie voor de zoekactie. Deze heeft de volgende indeling: (
|
| <page> (optioneel) | Hiermee wordt de lijst met records op basis van pagina's opgehaald. Deze heeft het gegevenstype NUMMER. Standaard - 1. |
| <perPage> (optioneel) | Hiermee wordt de lijst met beschikbare records per pagina opgehaald. Deze heeft het gegevenstype NUMMER. Standaard - 200. |
| <connections> (optioneel) | Hiermee worden de connectors weergegeven die bij de functie horen. Het gegevenstype is STRING. |
Voorbeeld van invoergegevens:
resp = zoho.crm.searchRecords("Leads", "(Company:equals:Zylker)");
Let op:
- Records zoeken op PDC is niet beschikbaar in versie 2.0.
- Als een kolom nullwaarden bevat, worden deze door zoho.crm.searchRecords NIET gerapporteerd in een <>-instructie.
- Op elk moment kunnen maximaal 200 records worden opgehaald.
Syntaxis (met API's van versie 1.0):
<response>=zoho.crm.v1.searchRecords(<module_name>, <criteria>, [<from_index>],[<to_index>]);
Gerelateerde records ophalen
Met verschillende componenten van CRM kan informatie over een bepaalde lead of contactpersoon worden opgeslagen. Een lead kan bijvoorbeeld een lijst met notities, een aantal deals of gekoppelde oproepen bevatten. Een notitie met betrekking tot een bepaalde record in een module kan worden gezocht met de taak zoho.crm.getRelatedRecords().
Syntaxis (met API's van versie 2.0):
<response>=zoho.crm.getRelatedRecords(<relation_name>, <parent_module_name>, <record_ID>, [<page>],[<perPage>], <connections>);
| Parameters | Beschrijving |
|---|---|
| <response> | De lijst met records die voldoen aan de ophaalcriteria. |
| <relatienaam> | De naam van de module (ook wel submodule genoemd) waarvan de record moet worden opgehaald. Deze heeft het gegevenstype STRING. Ondersteunde modules zijn: Notities, Offertes, Producten, Taken, Campagnes, Gebeurtenissen, Oproepen. |
| <parent_module_name> | De naam van de module waartoe de submodule behoort. Bijvoorbeeld: notities kunnen tot een bovenliggende module "Leads" behoren. Deze heeft het gegevenstype STRING. Ondersteunde modules zijn: Leads, Deals, Producten, Contactpersonen, Campagnes, Leveranciers, Accounts, Cases, Offertes, Salesorders, Inkooporders, Facturen en Aangepast. |
| <record_ID> | De record-id van de bovenliggende module die moet worden opgehaald. Deze heeft het gegevenstype NUMMER. |
| <page> (optioneel) | Hiermee wordt de lijst met records op basis van pagina's opgehaald. Deze heeft het gegevenstype NUMMER. Standaard - 1. |
| <perPage> (optioneel) | Hiermee wordt de lijst met beschikbare records per pagina opgehaald. Deze heeft het gegevenstype NUMMER. Standaard - 200. |
| <connections> (optioneel) | Hiermee worden de connectors weergegeven die bij de functie horen. Het gegevenstype is STRING. |
Let op:
- Op elk moment kunnen maximaal 200 records worden opgehaald.
Voorbeeld van invoergegevens:
Campagnes ophalen die betrekking hebben op een lead:
resp = zoho.crm.getRelatedRecords("Campaigns", "Leads", 2938383000000392001);
Taken ophalen die betrekking hebben op een lead:
resp = zoho.crm.getRelatedRecords("Task", "Leads", 2938383000000392001);
Syntaxis (met API's van versie 1.0):
<response>=zoho.crm.v1.getRelatedRecords(<module_name>, <parent_module_name>, <record_ID>, [<from_index>],[<to_index>]);
Gerelateerde records bijwerken
Met verschillende componenten van CRM kan informatie over een bepaalde lead of contactpersoon worden opgeslagen. U kunt de records die zijn gerelateerd aan een bovenliggende record bijwerken met de taak zoho.crm.updateRelatedRecord().
Syntaxis (met API's van versie 2.0):
<response>=zoho.crm.updateRelatedRecords(<relation_name>, <record_ID_1>, <parent_module_name>, <record_ID_2>, {<Nieuwe waarden als MAP-object>});
| Parameters | Beschrijving |
|---|---|
| <response> | De lijst met records die voldoen aan de ophaalcriteria. |
| <relatienaam> | De naam van de module (ook wel submodule genoemd) waarvan de record moet worden opgehaald. Deze heeft het gegevenstype STRING. Ondersteunde modules zijn: Notities, Offertes, Producten, Taken, Campagnes, Gebeurtenissen, Oproepen, E-mails. |
| <record_ID_1> | De id van de record die moet worden bijgewerkt. Deze heeft het gegevenstype NUMMER. |
| <parent_module_name> | De naam van de module waartoe de submodule behoort. Bijvoorbeeld: notities kunnen tot een bovenliggende module "Leads" behoren. Deze heeft het gegevenstype STRING. Ondersteunde modules zijn: Leads, Deals, Producten, Contactpersonen, Campagnes, Leveranciers, Accounts, Cases, Offertes, Salesorders, Inkooporders, Facturen en Aangepast. |
| <record_ID_2> | De record-id van de bovenliggende module die moet worden opgehaald. Deze heeft het gegevenstype NUMMER. |
| <Nieuwe waarden als MAP-object> | Sleutel. Waardeparen met bijgewerkte recordgegevens. Bijvoorbeeld: {"Last_Name": "Updated Name", "Fax": "555-858-3466"} |
Voorbeeld van invoergegevens:
De producthoeveelheid bijwerken:
resp = zoho.crm.v1.updateRelatedRecords("Products",2938383000000392001, "Leads", 2938383000000392001, {"Product_Quantity":"50"});
Syntaxis (met API's van versie 1.0):
<response>=zoho.crm.v1.updateRelatedRecords(<module_name>, <parent_module_name>, <record_ID>, [<from_index>],[<to_index>]);
Leads omzetten
De volgende stap na het verkrijgen van leads is onderhandelen, waarbij goede prospects van leads kunnen worden omgezet in contactpersonen. Met de taak zoho.crm.convertLead() kunt u gegevens van de lead overbrengen naar een record van een contactpersoon.
Syntaxis (met API's van versie 2.0):
<response>=zoho.crm.convertLead(<record_ID>, <overwrite>, <notify_lead_owner>, <notify_new_entity_owner>, <account_ID>);
| Parameters | Beschrijving |
|---|---|
| <response> | Het antwoord dat als een MAP wordt geretourneerd. |
| <record_ID> | De id van de record die moet worden opgehaald. Deze heeft het gegevenstype NUMMER. |
| <overschrijven> | Hiermee worden de gegevens overschreven als de lead al is geconverteerd. Het gegevenstype is BOOLEAN en de waarde moet waar of onwaar zijn. |
| <notify_lead_owner> | Wordt gebruikt om na conversie een melding te verzenden naar de eigenaar van de lead. Het gegevenstype is BOOLEAN en de waarde moet waar of onwaar zijn. |
| <notify_new_entity_owner> | Wordt gebruikt om na conversie een melding te verzenden naar de eigenaar van de nieuwe entiteit (contactpersoon). Het gegevenstype is BOOLEAN en de waarde moet waar of onwaar zijn. |
| <account_ID> (optioneel) | De id van de record die moet worden opgehaald. Deze heeft het gegevenstype NUMMER. |
Voorbeeld van invoergegevens:
resp = zoho.crm.convertLead(7000000037308, { "overwrite": true, "notify_lead_owner": false, "notify_new_entity_owner": true, "Accounts": "7000000037323", "Deals": { "Deal_Name": "Robert", "Closing_Date": "2016-03-30", "Stage": "Closed Won", "Amount": 56.6 } });
URL aanroepen
Niet alle gegevens zijn beschikbaar in uw CRM-systeem. Het kan voorkomen dat u gegevens uit andere services moet ophalen. Met de methode URL oproepen van de functie kunt u bewerkingen voor gegevensoverdracht uitvoeren.
Syntaxis (met API's van versie 2.0):
<response>=invokeUrl
[
];
| Parameters | Beschrijving |
|---|---|
| <response> | Het antwoord dat als een MAP wordt geretourneerd. |
| <url> | De URL van de endpoint-API van de Zoho-service of service van derden die u wilt aanroepen. |
| <type> | De HTTP-methode van de API-aanroep. Mogelijke waarden: GET/POST/PUT/PATCH/DELETE. |
| <parameters> | Wordt gebruikt om parameters te verzenden als "formuliergegevens". In feite worden de dynamische waarden in de API vervangen door gebruikersspecifieke waarden. |
| <kopteksten> | Wordt gebruikt om parameters voor aanvraagkopteksten op te geven. Deze zijn verplicht als er geen verbindingen worden gebruikt in de methode URL aanroepen. |
Als u de sandbox van uw CRM-systeem gebruikt, zijn er enkele wijzigingen in de URL van de methode. Hieronder vindt u een overzicht:
