Usando a Biblioteca de API no aplicativo de Automação Avançada

Recentemente, atualizamos nossa marca em nossas ofertas e mudamos os nomes de nossos planos de preços. Se você se inscreveu antes de 9 de agosto de 2021, clique em Planos anteriores para ver os planos aplicáveis.
 Garantimos que essa alteração não afetará sua experiência com o produto e nenhuma ação é necessária de sua parte.

O aplicativo Advanced Automations permite que você configure ações que são executadas em gatilhos específicos quando certas condições são atendidas. O aplicativo Advanced Automations está disponível no mercado Freshdesk Messaging. Clique aqui para conferir .  

Por exemplo, você pode atualizar, criar um tíquete e atualizar os campos personalizados no Freshdesk, enviar automaticamente mensagens de modelo no WhatsApp, etc.

Saiba mais sobre como configurar o aplicativo Advance Automations aqui.

As ações que você configura como parte das automações são executadas na ordem em que são listadas. O aplicativo verifica a primeira automação correspondente e a executa. Existem diferentes tipos de ações que você pode configurar como parte da automação. Acionar uma API é uma das ações mais poderosas e versáteis. Você pode configurar qualquer tipo de solicitação, especificar o endpoint da API, qualquer autenticação que usar, usar cabeçalhos personalizados, o formato de codificação e as informações no corpo do conteúdo.

Para configurar APIs no aplicativo Advanced Automations, você precisará primeiro alterná-lo em Settings> Advanced> APIs and Custom Placeholders. Este artigo abordará a configuração da biblioteca de APIs que você pode usar no aplicativo Automação avançada. Você pode aprender mais sobre como usar espaços reservados personalizados aqui .

• Configurando APIs
• Configurando automações com acionadores de API
• Aqui está um exemplo
• HandlebarsJS

Configurando APIs

1. Antes de começar, certifique-se de alternar em APIs e marcadores de posição em Configurações> Avançado> APIs e marcadores de posição personalizados.
   
   
   
2. Você pode configurar todas as suas APIs aqui em um só lugar e fazer uso das APIs várias vezes sempre que estiver configurando qualquer ação no aplicativo Automação avançada.
   
   
3. Depois de ativá-lo, você verá os ícones da biblioteca de API e os marcadores de posição personalizados. Clique no ícone da biblioteca de API> Criar uma API .
   
   
   
   
4. Dê um nome à sua API e um nome de modelo. O nome da API é para sua referência. O nome do modelo armazena a resposta da API. Use o nome do modelo para acessar a resposta da API em outras APIs ou ações subsequentes.
   
   
5. Escolha o tipo de solicitação. Embora cada aplicativo de terceiros possa usar um tipo de solicitação de maneira diferente, a maioria dos aplicativos segue estes métodos padrão:
   • As solicitações GET são normalmente usadas para recuperar um ou todos os recursos.
   • As solicitações POST geralmente criam novos recursos.
   • As solicitações PUT e PATCH são usadas para atualizar um recurso.
   • As solicitações DELETE geralmente são usadas para excluir um recurso.
     
     
6. Insira a URL do endpoint da API para os aplicativos aos quais você está se conectando. Você pode tornar os URLs dinâmicos usando espaços reservados .
   • Por exemplo, para adicionar a nota a um tíquete, você deve especificar a qual tíquete deseja que a nota seja adicionada. Seu URL seria: https://acme.freshdesk.com/api/v2/tickets/{{ticket.id}}/notes com o espaço reservado {{ticket.id}}.
     
     
7. Escolha a autenticação que você deseja usar. Você pode optar por incluir cabeçalhos personalizados e uma chave API ou uma autenticação de nome de usuário e senha. Os cabeçalhos personalizados transmitem informações como detalhes de segurança, detalhes da versão da API e assim por diante. Um cabeçalho personalizado deve ser inserido como um par cabeçalho-valor seguindo o formato especificado X-Sample-CustomHeader1: VALUE .
   
   

   Observação:

   O acionador não será executado quando um cabeçalho for fornecido com espaços entre eles, como X-Sample Custom Header1: VALUE. Porém, se um espaço for inserido no final do cabeçalho, ele será ignorado.

   
   
   • Um cabeçalho contendo mais de um valor deve ser separado por delimitadores (vírgulas e dois pontos não podem ser usados como delimitadores). Para adicionar um segundo cabeçalho, insira o cabeçalho personalizado e o par de valores na próxima linha.
     
     
8. Você pode usar qualquer um dos marcadores de posição padrão existentes ou torná-lo dinâmico usando marcadores de posição personalizados que você configurou para esses campos de autenticação. Você pode ler mais sobre o uso de marcadores de posição personalizados aqui .
   
   

   Nota :

   Embora ofereçamos a integração do Freshdesk fora da caixa para o aplicativo Advanced Automations, você também pode usá-lo com qualquer outro produto. Defina marcadores de posição personalizados com as informações de autenticação para usá-los em APIs como parte de uma ação.

   
   
9. Escolha sua opção de codificação entre XML, JSON e X-FORM-URLENCODED. Com base na sua escolha, o aplicativo Advanced Automations validará o corpo do conteúdo. Por exemplo, se você escolher JSON, o corpo do conteúdo precisa ser um formato JSON válido, caso contrário, uma mensagem de erro será exibida.
   
   
10. Clique em Concluído quando terminar.
    
    

Configurando automações com acionadores de API

1. Na tela de automações, crie uma nova automação ou edite as automações existentes.
   
   
2. Configure o acionador e todas as condições que você precisar.
   
   
3. Na tela Actions, escolha “trigger an API” e o aplicativo Advanced Automations mostrará a lista de APIs em sua biblioteca de API.
   
   

 Nota: Você pode definir uma API uma vez e usá-la muitas vezes com diferentes automações. 

Aqui está um exemplo

Vamos dar uma olhada nisso com um exemplo. Neste exemplo, já configuramos duas APIs.

• A primeira API cria um tíquete no Freshdesk, enquanto a segunda API adiciona uma resposta ao mesmo tíquete do Freshdesk.
  
  
• A segunda API usará o ID do tíquete que faz parte da resposta da primeira API usando o nome do modelo.
  
  
• A configuração da API freshdesk_ticket é igual à detalhada anteriormente neste artigo. Ao configurar a segunda API, teremos que nos certificar de que se refere ao nome do modelo da primeira API.

Nota: Você pode criar as APIs em qualquer ordem. Mas quando você usa APIs em Ações, as Ações serão executadas na ordem em que são usadas. Portanto, se uma API falhar, todas as APIs e ações subsequentes que dependem da primeira também falharão. 

A segunda API usa o campo URL para pesquisar a ID do tíquete, que faz parte do objeto de resposta do Freshdesk quando um tíquete é criado.

 Nota: Você pode consultar qualquer uma das propriedades que fazem parte dos objetos de resposta em outra resposta da API.

Por exemplo, quando você usa a API de criação de tíquete, o Freshdesk oferece as seguintes propriedades no objeto de resposta:

 {
 "cc_emails": ["ram@freshdesk.com", "diana@freshdesk.com"],
 "fwd_emails": [],
 "reply_cc_emails": ["ram@freshdesk.com", "diana@freshdesk.com"],
 "email_config_id": null,
 "group_id": nulo,
 "prioridade": 1,
 "requester_id": 129,
 "responder_id": nulo,
 "fonte": 2,
 "status": 2,
 "assunto": "Suporte necessário ..",
 "company_id": 1,
 "id": 1,
 "tipo": "Pergunta",
 "to_emails": null,
 "product_id": null,
 "fr_escalated": falso,
 "spam": falso,
 "urgente": falso,
 "is_escalated": falso,
 "created_at": "2015-07-09T13: 08: 06Z",
 "updated_at": "2015-07-23T04: 41: 12Z",
 "due_by": "2015-07-14T13: 08: 06Z",
 "fr_due_by": "2015-07-10T13: 08: 06Z",
 "description_text": "Alguns detalhes sobre o problema ...",
 "description": "<div> Alguns detalhes sobre o problema .. </div>",
 "Tag" : [ ],
 "anexos": []
 }