Notas da versão
Maior limite mínimo de uso da API
Aumentamos o limite mínimo de API em todas as edições para melhorar a sua experiência de uso da API.
Edição do Zoho CRM | Solicitações de API - limite superior |
Edição grátis | 1000 solicitações/dia/organização |
Edição Standard |
|
Edição Professional |
|
Edição Enterprise |
|
Para obter mais detalhes, consulte Limites de API para saber mais sobre essa alteração.
Lançado em: 1 de novembro de 2014
Novo método: searchRecords
Apresentamos o método searchRecords para ajudar a pesquisar registros de módulos. Consulte Guia de 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 os IDs de registros excluídos na lixeira:
Consulte nosso Guia de 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 API Zoho CRM está disponível em todas as edições do Zoho CRM. Para usar a API, você precisará do token de autenticação do Zoho CRM pela sua conta CRM. Verifique se você tem permissão para acessar o serviço API. Caso não tenha permissão, entre em contato com o administrador do CRM.
Limite de API
Edição do Zoho CRM | Solicitações de API - limite superior |
Edição grátis | 250 solicitações/dia/organização |
Edição Standard | Mínimo - 1000 solicitações/dia Máximo - 5000 solicitações/dia/organização ou 250 solicitações/licenças de usuários, o que for menor |
Edição Professional | Mínimo - 2000 solicitações/dia Máximo - 10000 solicitações/dia/organização ou 250 solicitações/licenças de usuários, o que for menor |
Edição Enterprise | Mínimo - 3000 solicitações/dia Máximo - 25000 solicitações/dia/organização ou 500 solicitações/licenças de usuários, o que for menor |
Notas importantes:
- Por exemplo, na edição grátis, se você usar o método getRecords, pode buscar um máximo de 200 registros por solicitação, por sua vez, um total de 50.000 registros por dia (250 x 200 = 50.000 registros).
- Se você usar os métodos getSearchRecords ou getCVRecords, pode enviar um máximo de 250 chamadas por dia, independentemente de sua edição do Zoho CRM.
Lançado em: 15 de junho de 2013
Novos métodos: anexe arquivos ou fotos a registros usando a API do desenvolvedor
Introduzimos os seguintes métodos que ajudam a anexar arquivos ou fotos aos registros:
- uploadFile
- downloadFile
- deleteFile
- uploadPhoto
- downloadPhoto
- deletePhoto
Você pode ler todo o anúncio em nossos Fóruns de API de desenvolvedores.
Consulte nosso Guia de API para saber mais sobre esses novos métodos.
Lançado em: 11 de julho de 2012
Token de autenticação introduzido
Agora suportamos o token de autenticação em nossa implementação da API do desenvolvedor.
Esse token é um token permanente, tornando-se inválido apenas se você optar por excluí-lo.
Saiba mais sobre o token de autenticação em nosso Guia de API.
Lançado em: segunda-feira, 5 de março de 2012
Novos métodos introduzidos
Introduzimos os seguintes métodos em nossa API de desenvolvedor:
- getFields
- getRelatedRecords
- updateRelatedRecords
Método de API | Finalidade |
getFields | Para buscar todos os detalhes dos campos disponíveis em um módulo específico. |
getRelatedRecords | Para buscar registros relacionados a outro registro (registro primário). . |
updateRelatedRecords | Para atualizar registros relacionados a outro registro. |
Você pode ler todo o anúncio em nossos Fóruns de API de desenvolvedores. Consulte nosso Guia de API para saber mais sobre esses novos métodos.
Lançado em: sexta-feira, 27 de janeiro de 2012
Suporte HTTPS somente a partir de 28 de abril de 2011:
No momento, oferecemos suporte tanto a HTTP como HTTPS enquanto implementamos nossa API de desenvolvedor. Em outro intervalo de tempo de 4 semanas, estamos planejando oferecer suporte a todas as transações de API somente via HTTPS e descontinuar permanentemente o protocolo HTTP. Esse sistema de segurança SSL de 256 bits adicional ajudará a proteger integrações de terceiros de problemas de segurança durante a transferência de dados.
Depois de 28 de abril de 2011, se você ainda continuar a usar HTTP no seu programa, as solicitações de API não serão executadas. Portanto, recomendamos enfaticamente a nossa comunidade de desenvolvedores fazer chamadas de API do Zoho CRM apenas com solicitações HTTPS o mais rápido possível.
Introduzido novo parâmetro chamado "versão"
Introduzimos um novo parâmetro chamado "versão" para métodos de API do desenvolvedor. Você pode buscar valores do campo "Origem da Campanha" com esse parâmetro.
Em um recente aprimoramento do módulo Campanhas, o campo Origem da Campanha foi removido para dar suporte ao recurso de membros da campanha. Após esse aprimoramento:
- Agora você pode associar várias oportunidades e contatos a uma campanha.
- Você pode economizar tempo importando várias oportunidades/contatos em vez de associá-las uma a uma.
- O campo Origem da Campanha não estará disponível no módulo Oportunidades e Contatos.
Saiba mais sobre esse aprimoramento em nosso Guia de transição.
Como você usa o parâmetro de versão em solicitações de API?
Você pode usar o parâmetro de versão em métodos para buscar valores pelo campo Origem da Campanha em sua implementação da API.
O parâmetro "versão" com valor "1" também irá buscar respostas do campo "Origem de Campanha".
O parâmetro "versão" com valor "2" irá buscar respostas com base na implementação da API atual. Os valores do campo "Origem da Campanha" não serão buscados nesse caso.
Esse 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ê deseja buscar respostas com base na nova implementação, poderá usar o parâmetro da versão em suas solicitações com um valor "2", ou seja, version=2.
Nota:
- Esse 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ê deseja buscar respostas com base na nova implementação, poderá usar o parâmetro da versão em suas solicitações com um valor "2", ou seja, version=2.
- Depois de 30 de outubro de 2011, descontinuaremos o suporte à versão 1, suportando apenas a versão 2.
Aqui está um exemplo do uso do parâmetro "versão".
Também introduzimos um novo método de API chamado getRelatedRecords. Você pode buscar registros (oportunidades, contatos etc.) relacionados a um registro em outro módulo.
Por exemplo, você pode buscar oportunidades ou contatos relacionadas a uma determinada campanha.Saiba mais
Lançado em: domingo, 17 de abril de 2011
Versão GA da API de desenvolvedor do Zoho CRM e outras alterações
Estamos muito satisfeitos de anunciar o lançamento da API 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 contribuição valiosa em direção à identificação de erros, criar novos cenários de negócios e publicação de exemplos realmente nos ajudou a apresentar uma melhor API para o nosso sistema de CRM. Além da versão GA, também estamos fazendo algumas grandes alterações em nossa implementação de API existente que nos permitem atender às necessidades futuras da nossa comunidade de desenvolvedores. Algumas dessas alterações incluem a deprecação de métodos de pesquisa, novo formato de resposta, restrição de solicitações de API e novos métodos de API para implementação de lógica de negócios de CRM adicional. Acreditamos sinceramente que essas alterações nos ajudarão bastante a proporcionar uma melhor experiência para a comunidade de desenvolvedores e a levar a plataforma de desenvolvedor do Zoho CRM para o próximo nível.
Alterações importantes
- Deprecação de métodos de pesquisa existentes - getAllSearchRecords e getMySearchRecords
- Implementação do 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 funções Pesquisar, Conversão de Oportunidades e Excluir
Deprecação de API
Mantendo o futuro crescimento da comunidade, um melhor serviço de desenvolvedor e a otimização de operações de desempenho intenso em vista, estamos descartando os seguintes métodos de API:
- getAllSearchRecords
- getMySearchRecords
Método de API | Finalidade |
getAllSearchRecords | Usado para buscar todos os dados com relação à palavra de pesquisa especificada, independentemente da propriedade. |
getMySearchRecords | Usado para buscar dados de propriedade do nome de login com 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 quantidade de utilização de recursos durante a implementação do getAllSearchRecords e getMySearchRecords muito maior do que o esperado. Para superar esse tipo de situação, estamos introduzindo novos métodos de pesquisa, getSearchRecords e getSearchRecordsByPDC, que servem a uma finalidade semelhante. Otimizamos esses novos métodos para melhorar o desempenho.
Fim de vida: 21 de janeiro de 2010
Nota:
- A partir de 21 de janeiro de 2010 (12:00 AM PST), esses métodos serão não funcionais e, se eles ainda forem usados, o sistema emitirá a seguinte mensagem de erro no seu aplicativo:
<resposta> Não foi possível processar sua solicitação. Verifique se você inseriu o nome do método, os parâmetros e os valores de parâmetros corretos
</resposta>
Nota Importante:
Antes do fim da vida, é altamente recomendado atualizar seu aplicativo com os novos métodos de pesquisa - getSearchRecords ou getSearchRecordsByPDC. Para qualquer ajuda ou esclarecimento, mande um e-mail para: support@zohocrm.com
Para obter mais detalhes sobre os métodos deprecados, consulte o nosso Guia de API
Novo formato de resposta
No momento, o formato XML para resposta de API é o < valor fieldlabel = "LEADID" > Valor do Campo </ fieldlabel>, que contém cerca de 26 caracteres (incluindo espaço) nas tags de abertura e de fechamento. Em nossa nova implementação, reduzimos o tamanho da tag alterando as tags XML para <FL val="LEADID"> Valor de Campo </FL> - total de 8 caracteres, o que economiza cerca de 18 bytes por campo. Isso será de grande ajuda para otimizar a utilização de largura de banda.
Até 21 de janeiro de 2010, por padrão, você verá a resposta no formato antigo. Se quiser obter a resposta no novo formato, você deve passar o argumento extra com newFormat=1 ou 2 na solicitação de 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 | Finalidade |
newFormat=1 | Para excluir campos com valores "nulos" ao buscar dados pela conta CRM. |
newFormat=2 | Para incluir campos com valores "nulos" ao buscar dados pela conta CRM. |
Formato antigo:
Nesse exemplo, todos os campos são buscados a despeito de valores "nulo" no registro. Se você tiver 150 campos em um módulo, precisamos buscar dados para todos os campos, o que requer a utilização desnecessária da largura de banda. Novo formato:
Nesse exemplo, não estamos buscando campos que contêm valores "nulo", passando o parâmetro newFormat=1. Pontos-chave:
- A tag XML foi alterada do <valor fieldlable=""> valor de campo </fieldlable> para <FL val=""> valor de campo <FL>
- Você pode parar de buscar registros com valores "nulo" passando newFormat=1 na solicitação de API. Se você quiser buscar dados para todos os campos (incluindo os valores nulo), use o parâmetro newFormat=2.
Novo formato de resposta - disponível a partir de 22 de outubro de 2009
EOL do formato de resposta antigo - 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 descrito abaixo:
Edição do Zoho CRM | Solicitações de API - limite superior |
Edição grátis - 3 usuários grátis | 250 chamadas/dia/organização |
Edição Professional - US$12/usuário/mês | 250 chamadas/dia/licença de usuário OU |
Edição Standard - US$20/usuário/mês | 250 chamadas/dia/licença de usuário OU |
Edição Enterprise - US$35/usuário/mês | 500 chamadas/dia/licença de usuário OU Máx: 25000 chamadas/dia/org, Mín: 3000 chamadas/dia/org |
Por exemplo, na Edição Grátis, se você estiver usando o método getSearchRecords, poderá buscar um máximo de 200 registros por solicitação, por sua vez, um total de 50.000 registros por dia (250 x 200 = 50.000 registros).
Nota:
- Se você estiver usando os métodos getSearchRecords ou getCVRecords, poderá enviar um máximo de 250 chamadas por dia, independentemente de sua edição do Zoho CRM.
Nota Importante:
As restrições acima são aplicáveis para todos os nossos usuários novos e existentes. No futuro, estamos planejando para notificar o administrador de CRM (Super administrador da conta do Zoho CRM) se a organização ultrapassar o limite mencionado acima. Além disso, também fornecemos estatísticas de API para melhorar a 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 (12:00 AM PST), você pode solicitar chamadas de API conforme a sua edição do Zoho CRM. No caso, seu aplicativo requer mais do que o limite superior, as solicitações de API adicionais não serão processadas. Para evitar problemas de transferência de dados, avalie seus requisitos de API com antecedência. Se 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 realmente entusiasmados para apresentar novos métodos a seguir para o benefício da crescente comunidade de desenvolvedores:
- getSearchRecords
- getSearchRecordsByPDC
- deleteRecords
- convertLead
Método de API | Finalidade |
getSearchRecords | Para buscar dados de todos os usuários especificados na solicitação de API. |
getSearchRecordsByPDC | Para pesquisar os valores com base no padrão de colunas pré-definidas de entidades do Zoho CRM. |
deleteRecords | Para excluir um registro, passando seu ID. |
convertLead | Para converter uma oportunidade 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 desenvolver a lógica de negócios adicionais pela nossa API. Esses métodos serão disponibilizados para todas as edições imediatamente.
Disponível em: 22 de outubro de 2009
Para obter mais informações sobre os novos métodos de API, consulte o nosso Guia de API
Outras alterações
Além disso, estamos incorporando as seguintes pequenas alterações:
- Buscar um máximo de 200 registros por solicitação de API
- O novo formato de resposta é aplicável a todos os métodos de API (tanto métodos existentes como métodos)
- Buscar registros com campos especificados usando o parâmetro selectColumns
- Também atualizamos o Guia de API e lançamos os Fóruns de desenvolvedores oficiais