Automação API Integrada - SelfService

Zap2Go permite que qualquer empresa crie seus processos de automação de acordo com suas necessidades.

O formato de Automação API integrada - Selfservice permite que o nosso cliente desenvolva seu próprio processo de automação de atendimento utilizando qualquer tecnologia que permita a implementação de WebApi. 

Este modelo de automação é bastante poderoso pois permite:

• Construir e manter sua automação de forma independente em seu ambiente, não precisando expor dados ou funções de seu ambiente;

• Dar manutenção rápida de acordo com suas prioridades de negócio;

• Ao mesmo tempo, utilizar todos os recursos do Zap2Go para facilitar e viabilizar o melhor atendimento para o seu cliente.

De forma geral, os conhecimentos técnicos e recursos exigidos para esta implementação são:

• Linguagem de programação na qual se possa desenvolver uma aplicação WebApi. Exemplos são: C#, Nodes.JS, Java, Python, VB.NET, PHP, etc.

• URL/rota do contratante para hospedar o serviço de API. Várias possibilidades podem ocorrer:

  • uso de infraestrutura e servers do cliente.

  • uso da infraestrutura Zap2Go.

  • comunicação via VPN.

  • etc.

• Definição de um padrão de segurança aberto, semi-restritivo ou restritivo para acesso.

• Conhecimento do fluxo operacional e sistêmico do cliente.

O modelo de implementação da API integrada é bastante simples e poderoso. Ele pode funcionar com pouco desenvolvimento e se tornará mais complexo quanto mais for complexo o processo interno do cliente.

O ponto de partida para efetuar esta implementação é o cliente de fato ter um fluxo de atendimento (fluxograma de etapas a serem cumpridas) esperado para execução.

Um fluxo por natureza contém:

• um ponto de partida (chamamos de step START).

• uma ou mais etapas "estáveis" (ponto em que o sistema fica aguardando um "reação" do usuário - são steps com nomes únicos entre si).

• transições entre steps (as setas dos fluxogramas): que ocorrem de acordo com as regras de negócio.

• zero, um ou mais steps de finalização (chamamos de step END). 

Pontos chave para a implementação: 

• O desenvolvimento terá como ponto de entrada somente um método na API, cujo objeto de Request também é padronizado.

• O método chamado terá apenas um padrão (objeto) de retorno.

• Uma chamada deste método ocorrerá quando:

  • o cliente enviou/respondeu uma mensagem;

  • foi executado algum processo configurado de renitência na carteira;

  • o próprio processo da api respondeu solicitando para ser chamado após X minutos.

• A resposta do método deverá ser uma lista de ações (Actions) a ser executada  pelo Zap2Go como "reação" à mensagem/renitência.

A solicitação (request) para a API dispõe dos seguintes atributos:

(1) Objeto Client

(2) Objeto Message

O retorno (response) que a API deve fazer possui os seguintes atributos:

(1) As seguintes oções de Actions estão disponíveis:

Notas adicionais:

• Todas as chamadas devem retornar actions. 

• É importante que a configuração de infraestrutura da API esteja preparada para receber pacotes de dados grandes, principalmente devido a envio de arquivos base64.

• O timeout para execução de uma API do cliente é de 60 segundos. Não é recomendável que o processo seja "lento" pois pode deixar um cliente muito tempo sem atendimento.

• Caso o processo dispare tarefas mais demoradas que o timeout, é ´possível a API controlar este processo de forma assíncrona e retornar o Action Resubmit para continuar após um tempo.

• Caso ocorra erro na chamada da API do cliente, a configuração de retentativas e intervalos é configurável (dentro de alguns limites).

• Estão previstas mudanças nos parâmetros de entrada e saída, com novos atributos. Estas serão atualizadas tanto aqui na documentação quanto no GitHub.

• Caso haja mudanças que impactem em regras de funcionamento das APIs, serão utilizados novos números de versão no request, garantindoa compatibilidade da versão já implementada.

Esta tendo algum problema?

CLIQUE AQUI ou então entre em contato com o GUGA - Suporte