A versão 1.0 dos APIs do Zoho CRM estão no final de seu período de vida útil e serão substituídos em 31 de dezembro de 2018. Recomendamos que você confira a nova e melhor API 2.0.
Uso do token de autenticação
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.
Gerar token de autenticação
Para gerar o token de autenticação, é necessário enviar uma solicitação de autenticação para contas Zoho usando o formato de URL abaixo. Verifique se você é um usuário confirmado, caso contrário, gerar o token de autenticação pode retornar um erro - "ACCOUNT_REGISTRATION_NOT_CONFIRMED".
Formato do URL
Modo de API:
Para gerar o token de autenticação no modo de API, faça o seguinte:
- Faça login no Zoho CRM.
- Abrir https://accounts.zoho.com .
- Na página inicial Contas Zoho, clique em Autenticação de Dois Fatores.
- Na página Autenticação de Dois Fatores, clique em Gerenciar Senhas Específicas ao Aplicativo.
- Na janela pop-up Senhas Específicas ao Aplicativo, faça o seguinte:
- Insira o nome do dispositivo ou do aplicativo
- Digite a senha atual
- Clique em Gerar. Você receberá a nova senha específica ao aplicativo com espaços.
- Remova os espaços na senha e inclua no seguinte URL de modo API para gerar o token de autenticação.
Nota:
- Use o método HTTP POST para fazer a solicitação.
Os parâmetros a serem transferidos junto com esse URL são:
| Parâmetro | Descrição |
| EMAIL_ID | Especifique o nome de usuário ou ID de e-mail do Zoho CRM |
| escopo | Especifique o valor como ZohoCRM/crmapi |
| SENHA | Especifique a senha do Zoho CRM |
| DISPLAY_NAME | Especifique o nome do aplicativo que descreve a finalidade de usar esse AuthToken. Por exemplo, "MailChimp" ou "Google Apps" |
Para obter mais informações, consulte a página Ajuda à autenticação de dois fatores .
Resposta da amostra
Nota:
- O token de autenticação pode ser usado em todas as chamadas de API. Você também pode ver o formato do URL em Configuração > Espaço do Desenvolvedor > APIs.
- É necessário estar conectado à conta CRM para usar o Modo de Navegação.
Exemplo
Veja um exemplo para buscar registros:
Revogação de tokens de autenticação
Você pode excluir o token de autenticação gerado para a sua conta pela página "Minha Conta Zoho".
- Faça login no Zoho CRM
- Abra [Nome de usuário] > Minha Conta
- Na página Contas, clique em Tokens de Autenticação Ativos.
- Na página Tokens de Autenticação Ativos, é possível remover(revogar) tokens de autenticação.
Nota:
- Para fins de segurança, você não será capaz de exibir os tokens de autenticação existentes. Salve o token de autenticação como e quando ele for gerado.
- A remoção de um token de autenticação excluirá o token permanentemente.
- Se você gerar novamente o token de autenticação, atualize seu programa com o novo token.
Pontos a lembrar
- O token de autenticação é específico ao usuário e é um token permanente.
- Na exclusão, o token existente será excluído permanentemente. O novo token deve ser substituído em todas as chamadas de API.
- O token de autenticação de uma conta de usuário se tornará inválido se o usuário for desativado.
- Notificaremos usuários do CRM (usuários que geraram o token de autenticação) se a organização exceder o limite de API.
- 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 você precisar de ajuda, entre em contato com nosso suporte em support@zohocrm.com