Como posso...

• Configurar funções
• Chamar uma função usando APIs REST
• Implantar funções nas regras de fluxo de trabalho
• Consultar códigos de erro
  • Códigos de status HTTP
  • Personalizar erros
• Exemplos de algumas funções comumente usadas
  ​[Tópicos relacionados]

Configurar funções

Você pode configurar funções em 5 locais:

• Criar uma função independente.
• Associar uma função a uma regra de fluxo de trabalho.
• Posteriormente, usar as funções, incluindo-as em Programações.
• Definir a função para ser executada após o clique de um botão personalizado.
• Associar uma função a uma Lista relacionada.

Para criar uma função

1. Vá para Configuração > Espaço do desenvolvedor > Funções.
2. Na página Funções, clique em + Criar Nova Função.
3. Escolha o local onde a função deve ser adicionada.
   
4. Clique em Avançar.
5. Na página Criar Função, faça o seguinte:
   • Dê um Nome e uma descrição (opcional) para a função.
   • Clique em Editar Argumentos.
   • Defina os argumentos a serem usados no script, com o nome de campo ou valor personalizado no módulo do CRM.
     
   • Escreva a função no Deluge Script Editor.
     
   • Clique em Salvar e Executar Script para validar o código.
   • Clique em Salvar.
6. Clique em Salvar.
   A função será listada na Visualização de lista da página Funções.
   Observe que as funções especificadas para serem usadas em um determinado local não podem ser usadas em nenhum outro lugar. Por exemplo: uma função configurada para Regras de Fluxo de Trabalho não pode ser usada em Programações.

Chamar funções usando APIs REST

Uma função permite que você tenha funcionalidades e recursos adicionais no seu CRM, além dos recursos convencionais. As funções precisam de um acionador para chamá-las. O acionador pode estar na forma de um fluxo de trabalho, um blueprint, uma lista relacionada ou através do clique de um botão.

Se a função precisa ser acionada sem o emprego desses métodos ou de fontes externas, você poderá criar funções independentes e disponibilizá-las como chamadas de API. O disparo funciona através de APIs REST que oferecem a flexibilidade para acioná-lo de qualquer lugar dentro do Zoho CRM ou de qualquer aplicativo de terceiros.

Função de amostra como uma chamada de API:

Um formulário que gera automaticamente um lead no CRM com as informações fornecidas como entrada no formulário.

Etapa 1:

Criar uma função independente com o código a seguir.

Etapa 2:

Para disponibilizar a função como uma API

1. Vá para Configuração > Espaço do desenvolvedor > Funções.
2. Clique no ícone Configurações da função correspondente que precisa ser criada como uma API.
3. Clique em API REST.
   
4. Defina o Nome da API para a função personalizada.
5. Habilite os controles deslizantes do OAuth2.0 e da chave de API.
6. Clique em Salvar.
   

Etapa 3:

A amostra aqui é mostrada como um formulário criado usando o Zoho Creator. Crie o formulário de forma que ele tenha os campos "Nome", "Sobrenome", "Empresa" e "Celular". Você pode programar a função para ser executada após o clique do botão Enviar.

Resultado:

Ao clicar no botão Enviar, a função é executada e o Lead é criado no CRM. O lead tem os detalhes que foram dados no formulário.

Funções em Postman:

Funções que são dadas como chamadas de API podem ser testadas usando o aplicativo POSTMAN. No entanto, existem algumas coisas que você precisa ter em mente ao executar uma função nesse aplicativo.

• Os métodos atuais suportados para usar uma função como uma API são GET e POST.
• Em uma solicitação de POST, na seção "Body", selecione "form-data".
• Crie uma Chave com o nome "arguments" e com o Valor como o objeto JSON de entrada.
• Os argumentos também podem ser fornecidos no URL como arguments={encoded_arguments}
• Solicitação de POST – Limite de argumentos
  • No URL de solicitação – 5.000 linhas
  • No corpo – 95.000 linhas (como objeto JSON)

Argumentos de amostra em "Body":

Implantar funções nas regras de fluxo de trabalho

Para associar uma função a uma regra de fluxo de trabalho

1. Vá para Configuração > Automação > Automação do Fluxo de Trabalho > Regras.
2. Na página Regras de Fluxo de Trabalho , clique em Criar Regra.
3. Na guia Criar Nova Regra, especifique os parâmetros da regra de fluxo de trabalho.
4. Em Ações Instantâneas, selecione Função.
   
5. Na página Configurar Função, selecione uma função na Galeria, Funções (criadas pelos usuários na organização) ou Escrever a sua usando o Deluge Script.
6. Clique em Funções (criadas pelos usuários da organização).
   
7. Selecione a função a ser acionada e clique em Configurar.
   
8. Na página Configurar Função Personalizada, conclua as seguintes etapas:
   • Selecione o módulo que deve ser associado.
   • Na seção Mapeamento de Argumento, mapeie o argumento com o nome de campo no módulo do CRM.
     
   • Clique em Salvar e Associar.
     Agora, você pode associar a função personalizada da galeria à regras de fluxo de trabalho.
9. Clique em Salvar na página Regra de fluxo de trabalho.
   Agora, sua função personalizada está associada à regra do fluxo de trabalho. Ao acionar a regra do fluxo de trabalho, a função personalizada será executada automaticamente.