Notas de Lançamento
Limite mínimo de uso da API aumentado
Aumentamos o limite mínimo de API em todas as edições para melhorar sua experiência de uso da API.
| Zoho CRM Edition | Solicitações de API – limite superior |
| Edição grátis | 1000 solicitações / dia / organização |
| Edição Padrão |
|
| Edição Profissional |
|
| Enterprise Edition |
|
Para mais detalhes, consulte Limites da API para saber mais sobre essa alteração.
Lançado em: 1 de novembro de 2014
Novo método: searchRecords
Introduzimos o método searchRecords para ajudá-lo a pesquisar registros de módulos. Consulte o Guia da API para saber mais sobre esse novo método.
Lançado em: 20 de outubro de 2014
Novos métodos: getModules e getDeletedRecordIds
Introduzimos os seguintes métodos para ajudá-lo a recuperar a lista de módulos de CRM e IDs de registros excluídos da lixeira:
Consulte nosso Guia da API para saber mais sobre esses novos métodos.
Lançado em: 7 de agosto de 2014
Número de solicitações de API
A Zoho CRM API está disponível em todas as edições do Zoho CRM. Para usar a API, você precisará do Zoho CRM Authentication Token da sua conta do CRM. Por favor, certifique-se de que você tem permissão para acessar o serviço da API. Se você não tiver permissão, entre em contato com o administrador do CRM.
Limite de API
| Zoho CRM Edition | Solicitações de API – limite superior |
| Edição grátis | 250 solicitações / dia / organização |
| Edição Padrão | Mínimo – 1000 solicitações / dia Máximo – 5000 solicitações / dia / Organização ou |
| Edição Profissional | Mínimo – 2000 Solicitações / dia Máximo – 10000 Solicitações / dia / Organização ou |
| Enterprise Edition | Mínimo – 3000 solicitações / dia Máximo – 25000 solicitações / dia / organização ou |
Anotações importantes:
- Por exemplo, na Free Edition, se você usar o método getRecords, poderá buscar no máximo 200 registros por solicitação, um total de 50.000 registros por dia (250 x 200 = 50.000 registros).
- Se você usar os getSearchRecords ou getCVRecords métodos, você pode enviar um máximo de 250 chamadas por dia , independentemente da sua edição Zoho CRM.
Lançado em: 15 de junho de 2013
Novos métodos: Anexar arquivos ou fotos a registros usando a API do desenvolvedor
Introduzimos os seguintes métodos que ajudam você a anexar arquivos ou fotos aos registros:
- subir arquivo
- ⇬ Fazer download do arquivo
- deleteFile
- uploadPhoto
- downloadPhoto
- deletar foto
Você pode ler o anúncio completo em nossos Fóruns da API do desenvolvedor .
Consulte nosso Guia da API para saber mais sobre esses novos métodos.
Lançado em: 11 julho, 2012
Token de Autenticação Introduzido
Agora, suportamos o token de autenticação em nossa implementação da API do desenvolvedor.
Este token é um token permanente e se tornará inválido somente se você optar por excluí-lo.
Saiba mais sobre o token de autenticação em nosso Guia da API .
Lançado em: 05 de março de 2012
Novos métodos introduzidos
Introduzimos os seguintes métodos na nossa API do desenvolvedor:
- getFields
- getRelatedRecords
- updateRelatedRecords
| Método API | Propósito |
| getFields | Para buscar todos os detalhes dos campos disponíveis em um determinado módulo. |
| getRelatedRecords | Buscar registros relacionados a outro registro (registro primário). . |
| updateRelatedRecords | Para atualizar registros relacionados a outro registro. |
Você pode ler o anúncio completo em nossos Fóruns da API do desenvolvedor . Consulte nosso Guia da API para saber mais sobre esses novos métodos.
Lançado em: 27 de janeiro de 2012
Apenas suporte HTTPS de 28 de abril de 2011:
No momento, estamos oferecendo suporte a HTTP e HTTPS durante a implementação da nossa API de desenvolvedor. Em outro período de 4 semanas, planejamos oferecer suporte a todas as transações da API somente por meio de HTTPS e descontinuar permanentemente o protocolo HTTP . Esse sistema adicional de segurança SSL de 256 bits ajudará você a proteger a integração de terceiros contra problemas de segurança durante a transferência de dados.
Depois de 28 de abril de 2011 , se você continuar a usar o HTTP em seu programa, as solicitações da API não serão executadas. Portanto, recomendamos que nossa comunidade de desenvolvedores chame a Zoho CRM API somente com solicitações HTTPS, o mais rápido possível.
Novo parâmetro chamado ‘versão’ introduzido
Introduzimos um novo parâmetro chamado version for Developer API methods. Você pode buscar valores no campo “Origem da campanha” com esse parâmetro.
Em um aprimoramento recente do módulo “Campanhas”, o campo Origem da campanha foi removido para oferecer suporte ao recurso de membros da campanha. Após este aprimoramento:
- Agora você pode associar vários leads e contatos a uma campanha.
- Você pode economizar tempo importando vários leads / contatos em vez de associá-los um por um.
- O campo Origem da campanha não estará disponível no Leads e no módulo Contatos.
Saiba mais sobre esse aprimoramento em nosso Guia de Transição .
Como você usa o parâmetro de versão nas solicitações da API?
Você pode usar o parâmetro version em métodos para buscar valores no campo Origem da campanha na sua implementação da API.
O parâmetro “versão” com um valor “1” também buscará respostas do campo “Origem da campanha”.
O parâmetro “versão” com um valor “2” buscará respostas com base na implementação atual da API. Os valores do campo “Origem da campanha” não serão buscados neste caso.
Este não é um parâmetro obrigatório. Até 30 de outubro de 2011, todas as respostas serão obtidas com base na implementação anterior, ou seja, antes do aprimoramento. Durante esse período, se você quiser buscar respostas com base na nova implementação, poderá usar o parâmetro version em suas solicitações com um valor ‘2’, ou seja, versão = 2.
Nota:
- Este não é um parâmetro obrigatório.
- Até 30 de outubro de 2011, todas as respostas serão obtidas com base na implementação anterior, ou seja, antes do aprimoramento. Durante esse período, se você quiser buscar respostas com base na nova implementação, poderá usar o parâmetro version em suas solicitações com um valor ‘2’, ou seja, versão = 2.
- Depois de 30 de outubro de 2011, descontinuaremos o suporte para a versão 1 e ofereceremos suporte apenas à versão 2.
Aqui está um exemplo sobre o uso do parâmetro “version”.
Também introduzimos um novo método de API chamado getRelatedRecords . Você pode buscar registros (Leads, Contatos, etc) relacionados a um registro em outro módulo.
Por exemplo, você pode buscar Leads ou Contatos relacionados a uma campanha específica. Saber mais
Lançado em: 17 de abril de 2011
GA Release do Zoho CRM Developer API e outras alterações
Temos o prazer de anunciar o lançamento do GA para o serviço Zoho CRM. Nossa API está disponível nos formatos XML e JSON, o que ajuda a comunidade de desenvolvedores a criar aplicativos usando sua linguagem de programação favorita. Agora estamos prontos com métodos de API robustos e muito melhores para atender às necessidades de implantações em tempo real. Sua valiosa contribuição para identificar bugs, criar novos cenários de negócios e publicar exemplos realmente nos ajudou a criar uma API melhor para nosso sistema de CRM. Além do lançamento do GA, também estamos fazendo algumas mudanças importantes em nossa implementação de API existenteque nos permite atender às necessidades futuras de nossa comunidade de desenvolvedores. Algumas dessas alterações incluem, métodos obsoletos de pesquisa, novo formato de resposta, restrição de solicitações de API e novos métodos de API para implementar uma lógica de negócios adicional do CRM. Acreditamos sinceramente que essas mudanças nos ajudarão muito a fornecer uma experiência melhor para a comunidade de desenvolvedores e levar a plataforma de desenvolvedores Zoho CRM para o próximo nível.
Mudanças Importantes
- Depreciação de métodos de pesquisa existentes – getAllSearchRecords e getMySearchRecords
- Implementação de novo formato de resposta para todos os métodos
- Restrição de solicitações de API com base na edição do Zoho CRM
- Introdução de novos métodos para as funções Search, Lead Conversion e Delete
Deprecação da API
Mantendo o crescimento futuro da comunidade, melhores serviços para desenvolvedores e otimização das operações de alto desempenho em vista, estamos eliminando os seguintes métodos da API:
- getAllSearchRecords
- getMySearchRecords
| Método API | Propósito |
| getAllSearchRecords | Usado para buscar todos os dados em relação à palavra de pesquisa especificada, independentemente da propriedade. |
| getMySearchRecords | Usado para buscar dados de propriedade do nome de login em relação à palavra de pesquisa especificada na solicitação. |
| getAllRecords | O nome foi alterado para getRecords |
| getEntityRecord | O nome foi alterado para getRecordById |
Ultimamente, estamos encontrando uma enorme quantidade de utilização de recursos ao implementar os getAllSearchRecords e getMySearchRecords do que o esperado. Para superar esse tipo de situação, estamos introduzindo novos métodos de pesquisa, getSearchRecords e getSearchRecordsByPDC , que servem ao mesmo propósito. Nós otimizamos esses novos métodos para um melhor desempenho.
Fim da vida: 21 de janeiro de 2010
Nota:
- A partir de 21 de janeiro de 2010 (12h00 PST) esses métodos não serão funcionais e, se você ainda usá-los, o sistema emitirá a seguinte mensagem de erro em seu aplicativo:
<response> Não é possível processar sua solicitação. Por favor, verifique se você entrou com o nome do método, parâmetro e valores de parâmetro adequados
</ response>
Nota importante:
Antes do fim da vida, é altamente recomendável atualizar seu aplicativo com os novos métodos de pesquisa – getSearchRecords ou getSearchRecordsByPDC . Para qualquer ajuda ou esclarecimento, por favor envie-nos para: support@zohocrm.com
Para mais detalhes sobre os métodos obsoletos, consulte nosso Guia da API.
Novo formato de resposta
No momento, o formato XML da resposta da API é < fieldlabel value = “LEADID” > Field Value </ fieldlabel >, que contém cerca de 26 caracteres (incluindo espaço) nas tags de abertura e fechamento. Em nossa nova implementação, reduzimos o tamanho da tag alterando as tags XML para <FL val = “LEADID”> Field Value </ FL> – total de 8 caracteres, o que economiza cerca de 18 bytes por campo. Isso nos ajudará muito a otimizar a utilização da largura de banda.
Até 21 de janeiro de 2010, por padrão, você receberá a resposta no formato antigo. Se você deseja obter a resposta no novo formato, você deve passar o argumento extra com newFormat = 1 ou 2 na solicitação da API para buscar dados do Zoho CRM.
Nota importante:
Observe que você deve usar os dados XML do parâmetro newFormat = 1 para inserir ou atualizar registros.
| Parâmetro | Propósito |
| novoFormato = 1 | Para excluir campos com valores “nulos” ao buscar dados da sua conta do CRM. |
| novoFormato = 2 | Para incluir campos com valores “nulos” ao buscar dados da sua conta do CRM. |
Formato antigo:
<response uri = “/ crm / private / xml / Leads / getAllRecords”>
<resultado>
<Leads>
<row no = “1”> < valor do rótulo de campo = “LEADID”> 1111111111 < fieldlabel>
<fieldlabel value = “SMOWNERID” > 222222222 </ fieldlabel>
<fieldlabel value = “Proprietário do lead”> soori </ fieldlabel>
<fieldlabel value = “Empresa”> NiveSoft </ fieldlabel>
<fieldlabel value = “Primeiro nome”> Mutha </ fieldlabel>
<valor do rótulo de campo = “Apelido”> Raja </ fieldlabel>
<fieldlabel value = “Designação”> null </ fieldlabel>
<fieldlabel value = “Email”>null </ fieldlabel>
<fieldlabel value = “Telefone”> 3434343 </ fieldlabel>
<valor do rótulo de campo = “Fax”> nulo </ fieldlabel>
<fieldlabel value = “Mobile”> nulo </ fieldlabel>
<fieldlabel value = “Website”> nulo </ fieldlabel>
<fieldlabel value = “Fonte de chumbo”> nulo </ fieldlabel>
<fieldlabel valor = “Estado do chumbo”> nulo </ fieldlabel>
<fieldlabel value = “Indústria”> null </ fieldlabel>
<fieldlabel value = “Número de empregados”> 0 </ fieldlabel>
<fieldlabel value = “Receita anual”> 0.0 </ fieldlabel>
<valor do rótulo de campo = “Avaliação”> null </ fieldlabel>
<fieldlabel value = “CAMPAIGNID”> nulo </ fieldlabel>
<fieldlabel value = “Origem da campanha”> null </ fieldlabel>
<fieldlabel valor = “SMCREATORID”> 22222222 </ fieldlabel>
<fieldlabel value = “Criado por”> jkbmahesh </ fieldlabel>
<fieldlabel value = “MODIFIEDBY”> 22222222 </ fieldlabel>
<valor do fieldlabel = “Modificado por”> jkbmahesh </ fieldlabel>
<fieldlabel value = “Tempo de Criação”> 2009-02-22 18:20:38 </ fieldlabel>
<fieldlabel value = “Hora modificada”> 2009-10-05 16:01:32 </ fieldlabel>
<fieldlabel value = “Street”> nula </ fieldlabel>
<fieldlabel value = “Cidade”> nula </ fieldlabel>
< fieldlabel value = “Estado”> nulo </ fieldlabel>
<fieldlabel value = “CEP”> nulo </ fieldlabel>
<valor do campo de etiqueta = “País”>null </ fieldlabel>
<fieldlabel value = “Descrição”> nulo </ fieldlabel>
<valor do campo de etiqueta = “ID do Skype”>null <fieldlabel>
<fieldlabel value = “Desativar o email”> false </ fieldlabel>
<fieldlabel value = “Saudação”> null </ fieldlabel>
<valor do rótulo de campo = “rrr”> nulo </ fieldlabel>
<valor do rótulo de campo = “int field”> nulo </ fieldlabel>
<fieldlabel value = “Moeda (Round Up)”> nulo </ fieldlabel>
<fieldlabel valor = “Numeração Automática”> 1 </ fieldlabel>
<row no = “2”>
…
</ row>
</ Leads>
</ result>
</ response>
Neste exemplo, todos os campos são buscados apesar dos valores “nulos” no registro. Se você tiver 150 campos em um módulo, teremos que buscar dados para todos os campos, o que requer utilização desnecessária de largura de banda. Novo formato:
<response uri = “/ crm / private / xml / Leads / getAllRecords”>
<resultado>
<Leads>
<row não = “1”>
< FL val = “LEADID”> 1111111111 </ FL >
<FL val = “SMOWNERID “> 1111122222 </ FL>
<FL val =” Proprietário do lead “> soori </ FL>
<FL val =” Companhia “> NiveSoft </ FL>
<FL val =” Primeiro nome “> Mutha </ FL>
<FL val = “Sobrenome”> Raja </ FL>
<FL val = “E-mail”> </ FL>
<FL val = “Telefone”> 3434343 </ FL>
<FL val = “Não de funcionários”> 0 </ FL>
<FL val = “Receita anual”> 0,0 </ FL>
<FL val = “SMCREATORID”> 22222222 </ FL>
<FL val = “Criado por”> jkbmahesh </ FL>
<FL val = “MODIFICADO”> 22222222 </ FL>
<FL val = “Modificado por “> jkbmahesh </ FL>
<FL val = “Tempo de criação”> 2009-02-22 18:20:38 </ FL>
<FL val = “Tempo de modificação”> 2009-10-05 16:01:32 </ FL>
<FL val = “Desativar e-mail”> false </ FL>
<FL val = “Num. Automático”> 1 </ FL>
</ row>
<row no = “2”>
….
</ row>
</ Leads>
< / result>
</ response>
Neste exemplo, não estamos buscando os campos que contêm valores ” Nulos ” passando o parâmetro newFormat = 1 . Pontos chave:
- A tag XML foi alterada de <fieldlable value = “”> valor do campo </ fieldlable> para <FL val = “”> valor do campo <FL>
- Você pode parar de buscar registros com valores “nulos” passando o newFormat = 1 na solicitação da API. Se você deseja buscar dados para todos os campos (incluindo valores nulos ), use o parâmetro newFormat = 2 .
Novo formato de resposta – disponível a partir de 22 de outubro de 2009
EOL do antigo formato de resposta – 21 de janeiro de 2010
Número de solicitações de API
Para um melhor desempenho e serviço de desenvolvedor, limitaremos o número de solicitações de API, conforme abaixo:
| Zoho CRM Edition | Solicitações de API – limite superior |
| Free Edition – 3 usuários grátis | 250 chamadas / dia / organização |
| Edição Profissional – USD 12 / usuário / mês | 250 chamadas / dia / licença de usuário OU Máximo: 5000 chamadas / dia / org, Min: 1000 chamadas / dia / org |
| Standard Edition – USD 20 / usuário / mês | 250 chamadas / dia / licença de usuário OU Max: 10000 chamadas / dia / org. Min: 2000 chamadas / dia / org |
| Enterprise Edition – USD 35 / usuário / mês | 500 chamadas / dia / licença de usuário OU Max: 25000 chamadas / dia / org., Min: 3000 chamadas / dia / org |
Por exemplo, na Free Edition, se você estiver usando o método getSearchRecords , poderá buscar no máximo 200 registros por solicitação, um total de 50.000 registros por dia (250 x 200 = 50.000 registros).
Nota:
- Se você estiver usando o getSearchRecords ou getCVRecords métodos, você pode enviar um máximo de 250 chamadas por dia , independentemente da sua edição Zoho CRM.
Nota importante:
As restrições acima são aplicáveis a todos os nossos usuários novos e existentes. No futuro, estamos planejando notificar o administrador do CRM (Super Administrador da conta Zoho CRM) se sua organização exceder o limite mencionado acima. Além disso, também forneceremos estatísticas de API para melhor avaliação de seus requisitos de integração.
Data de implementação: 21 de janeiro de 2010
A partir de 21 de janeiro de 2010 (12h00 PST) , você pode solicitar chamadas API de acordo com o seu Zoho CRM Edition. No caso, seu aplicativo requer mais do que o limite superior, suas solicitações de API adicionais não serão processadas. Para evitar problemas de transferência de dados, avalie seus requisitos de API com bastante antecedência. Se você precisar de ajuda, entre em contato com nosso suporte em support@zohocrm.com ou ligue para +1 888 900 9646
Novos métodos de API
Estamos muito animados para apresentar os novos métodos a seguir em benefício da crescente comunidade de desenvolvedores:
- getSearchRecords
- getSearchRecordsByPDC
- deleteRecords
- convertLead
| Método API | Propósito |
| getSearchRecords | Para buscar todos os dados de usuários especificados na solicitação da API. |
| getSearchRecordsByPDC | Para pesquisar os valores com base nas colunas predefinidas padrão das entidades do Zoho CRM. |
| deleteRecords | Para excluir um registro passando seu ID. |
| convertLead | Para converter leads em conta, contato e potencial. |
Estamos confiantes de que os métodos acima serão muito úteis na implementação de funções de pesquisa e permitem que você desenvolva lógica de negócios adicional por meio de nossa API. Esses métodos serão disponibilizados para todas as edições imediatamente.
Disponível a partir de: 22 de outubro de 2009
Para mais informações sobre novos métodos da API, consulte nosso Guia da API.
Outras alterações
Além disso, estamos incorporando as seguintes pequenas alterações:
- Buscar no máximo 200 registros por solicitação de API
- O novo formato de resposta é aplicável a todos os métodos da API (tanto existentes quanto novos métodos)
- Buscar registros com os campos especificados usando o parâmetro selectColumns
- Também atualizamos o API Guide e lançamos os fóruns oficiais de desenvolvedores
