API
- Carina Soca
- Rodrigo Monteiro (Voice Engineering)
Analytics
Veja as diferentes possibilidades que nossa API lhe oferece para integrar o uContact a sistemas externos.
Para usar a API, você precisa:
Autenticar e obter um token para a sessão.
Usar o token no cabeçalho de autorização.
Fazer logout.
Recomenda-se criar um usuário que seja usado exclusivamente com a API do uContact.
Em primeiro lugar, precisamos obter a APIkey. Para isso, usamos o serviço getUserToken com um nome de usuário e uma senha válidos do SuperUser.
Serviço getUserToken
https://dominio.ucontactcloud.com/Integra/resources/auth/getUserToken
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: user
password
Resultado: JSONSupervisor sem telefone
Al final de la lista
[ ...
"QWRtaW46OTgzNWM1MjUtMzU2Ny00YjgyLWEwYWYtY2NkMjNlMDhjNzA3"
]
Si es Error Respuesta 0Código de exemplo para jQuery
$.ajax({
type: 'POST',
url: 'https://dominio.ucontactcloud.com/Integra/resources/auth/getUserToken',
contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
dataType: 'text',
data: {
user: 'ExampleUsername',
password: 'ExamplePassword'
},
success: (resp) => {},
error: (resp) => {}
});Depois que você tiver seu token de login, vamos ver como usá-lo nas consultas de API:
O jQuery pode ser configurado para usar o token em todas as solicitações.
Caso contrário, ele pode ser especificado nos cabeçalhos de cada solicitação feita.
Exemplo de configuração de jQuery
Exemplo de token em cabeçalhos de solicitação
Depois de usar a API, é necessário encerrar a sessão. Dessa forma, evitaremos problemas de segurança ao desativar o token gerado no login inicial.
Método
Código de exemplo para jQuery
Informações relevante
Todos os WebServices são do tipo REST.
O uContact usa https por padrão (http2).
Conexão entre Domínios
Conexão entre domínios
Com o proxy do Windows, podemos manipular eventos de um iframe inserido em um formulário, para poder fazer disposições, desligar a chamada, fechar o formulário ou o que você quiser, por exemplo. Para fazer isso, não é necessário nenhum plug-in.
Etapas anteriores
No formulário, você deve colocar:
event.data pode ser usado para identificar o tipo de ação.
E o atributo disposition é usado como um objeto para enviar mais informações.
Como solicita-lô?
A maneira de solicitar é:
Criação de tokens
Os usuários com a função “SuperUser” no uContact têm a funcionalidade de criar tokens para uso fora do aplicativo. Para criar um token, siga estas etapas:
Acesse o menu do usuário.
Selecione a opção “API tokens” no menu suspenso e um modal será aberto para sua criação.
Digite o nome que você deseja usar para identificar o token e clique no botão “Save” (Salvar) para criar um novo token.
Depois que um token for criado no uContact, os “SuperUser” poderão compartilhá-lo com outros usuários. Para isso, basta clicar no ícone de clipe. Isso copiará automaticamente o token para a área de transferência e ele poderá ser enviado para qualquer pessoa com quem você queira compartilhá-lo.
Links de interesse
Coleção Postman para login e logout.
