V2 x V1
A atualização da Versão 2.0 do Zoho APIs teve grande impacto sobre o uso de APIs e Funções (funções personalizadas previamente). O funcionamento das APIs são praticamente o mesmo, mas a sintaxe, a saída e os métodos são diferentes.
O objetivo deste documento é apresentar a diferença entre as duas APIs e também para ajudar os usuários a melhor entender a Versão 2.0.
O que é diferente na V2:
- Os formatos de respostas e entradas API têm suporte somente a JSON.
- As APIs são autenticadas pelo protocolo OAuth 2.0.
- Há Nomes API para módulos, campos e listas_relacionadas, na versão 2.0, em vez da etiqueta de exibição como na Versão 1.0.
- Os limites de chamada de API são baseados na janela contínua de 24 horas, enquanto na V 1.0, o limite de chamada de API é baseado no fuso horário PST.
- Os valores de data e hora são no formato ISO 8601 (2018-03-28T10:32:45+05:30).
- Todos os nomes API iniciados com $ são atributos somente-leitura.
- Quando você usa GET para um registro, a resposta para campos vazios é JSON Null.
- Os nomes API do módulo podem ser obtidos com "https://www.zohoapis.com/crm/v2/settings/modules" – URL de solicitação
- Nas APIs de inserir, atualizar e upsert, ações automatizadas como fluxo de trabalho, aprovação e blueprint podem ser acionadas para todos os registros com a tecla de "trigger": [“approval”,”workflow”,”blueprint”]
- Nas APIs GET, as respostas terão uma informação JSONObject. Ex:
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}- page: para obter a lista de registros das respectivas páginas. O valor padrão é 1.
- per_page: para obter a lista de registros disponíveis por página. O valor padrão é 200.
- more_records é para indicar se deve ser feita uma chamada API extra para buscar o próximo conjunto de registros
- getMyRecords(API v1.0) pode ser chamada com a API searchRecords na v2.0
Mudanças de atributo de campo:
| Na API Versão 1.0 | Equivalente na API Versão 2.0 |
|---|---|
| {MODULE}ID (Ex. LEADID,CONTACTID etc.) | id |
| SMOWNERID | id fornecida no JSONObject proprietário. |
| {MODULE} OWNER (Ex. Proprietário do lead, Proprietário do caso) | nome fornecido no JSONObject proprietário. |
| SMCREATORID | id fornecido no JSONObject Created_By |
| Created By | nome fornecido no JSONObject Created_By. |
| MODIFIEDBY | id fornecida no JSONObject Modified_By |
| Modified By | nome fornecido no JSONObject Modified_By. |
Tipos de formato de campo:
| Tipo de campo | Formato V1.0 | Formato V2.0 |
|---|---|---|
| Linha única | <FL val="Single_Line 1"> <![CDATA[this is single line]]> </FL> | "Single_Line_1": “This is single line”, |
| Várias linhas | <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", | |
| Telefone | <FL val="Phone 1"><![CDATA[9900000000]]></FL> | "Phone_1": "9900000000", |
| Lista de seleção | <FL val="picklist1"><![CDATA[one]]></FL> | "picklist1": "one", |
| Lista de múltipla seleção | <FL val="Multi-Select 1"><![CDATA[Option1;Option 2]]></FL> | "Multi_Select_1": [ "Option 1", "Option 2" ] |
| Data | <FL val="Date 1"><![CDATA[2018-03-29]]></FL> | "Date_1": "2018-03-29", |
| Data/Hora | <FL val="Date/Time 1"><![CDATA[2018-04-07 10:00:00]]></FL> | "Date_Time_1": "2018-04-07T10:00:00+05:30", |
| Número | <FL val="Number 1"><![CDATA[50000]]></FL> | "Number_1": 50000, |
| Moeda | <FL val="Currency 1"><![CDATA[230000500]]></FL> | "Currency_1": 230000500, |
| Decimal | <FL val="Decimal 1"><![CDATA[1234.9]]></FL> | "Decimal_1": 1234,9, |
| Percentual | <FL val="Percent 1"><![CDATA[12.3]]></FL> | "Percent_1": 12,3, |
| Número inteiro longo | <FL val="Long Integer 1"><![CDATA[6780000000780000]]></FL> | "Long_Integer_1": "6780000000780000", |
| Caixas de seleção | <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", |
| Pesquisa | <FL val="Lookup 1"><![CDATA[9500495sam]]></FL> | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
| Proprietário do registro | <FL val="SMOWNERID">1386586000000078001</FL> <FL val="Lead Owner"<>![CDATA[BruceWills]]></FL> | "Owner": { "name": "Bruce Wills", "id": "1386586000000078001" }, |
| Layout | N/A | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
Métodos API
| Nome do método | Finalidade |
|---|---|
| getRecords | Para recuperar dados de todos os usuários especificados na solicitação API |
| getRecordById | Para recuperar registros individuais por ID do registro |
| getDeletedRecordIds | Para recuperar da lixeira a lista de IDs de registros excluídos |
| insertRecords | Para inserir registros no módulo Zoho CRM Zoho necessário |
| updateRecords | Para atualizar ou modificar os registros no Zoho CRM |
| getSearchRecordsByPDC | Para pesquisar valores com base em colunas predefinidas |
| deleteRecords | Para excluir os registros selecionados |
| convertLead | Para converter leads em potencial, conta e contato |
| getRelatedRecords | Para recuperar registros relacionados a um módulo primário |
| getFields | Para recuperar detalhes dos campos disponíveis em um módulo |
| updateRelatedRecords | Para atualizar registros relacionados a outro registro |
| getUsers | Para recuperar a lista de usuários em sua organização |
| uploadFile | Para anexar um arquivo a um registro |
| delink | Para desassociar o relacionamento entre os registros pai e filho |
| downloadFile | Para fazer download de um arquivo anexado a um registro |
| deleteFile | Para excluir um arquivo anexado a um registro |
| uploadPhoto | Para adicionar uma foto a um contato ou lead |
| downloadPhoto | Para fazer download da foto de um contato ou lead |
| deletePhoto | Para excluir a foto de um contato ou lead |
| getModules | Para recuperar todos os módulos da conta do Zoho CRM |
| searchRecords | Para recuperar os registros que correspondem aos seus critérios de pesquisa |
