API
Ā
Vea las diferentes posibilidades que le brinda nuestra API para integrar a uContact con sistemas externos.
Para poder usar la API se necesita.
Autenticarse y obtener un token para la sesiĆ³n.
Usar el token en el Header Authorization.
Finalizar sesiĆ³n.
Se recomienda crear un usuario que sea exclusivamente para utilizar con la API de uContact.
Ā
En primer lugar, debemos obtener APIkey. Para ello utilizamos el servicio getUserToken con un usuario y contraseƱa de SuperUser vƔlidos.
Servicio 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: JSON
Supervisor sin telƩfono
Al final de la lista
[ ...
"QWRtaW46OTgzNWM1MjUtMzU2Ny00YjgyLWEwYWYtY2NkMjNlMDhjNzA3"
]
Si es Error Respuesta 0
CĆ³digo de ejemplo 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) => {}
});
Una vez que tiene su token de inicio de sesiĆ³n,
pasaremos a ver como utilizarlo en las consultas a la API:
Se puede configurar jQuery para que use el token en cada peticiĆ³n.
Si no, se puede especificar en los headers en cada peticiĆ³n que se haga.
Ejemplo de configuraciĆ³n de jQuery
Ejemplo de token en headers de peticiones
Luego de utilizar la API es necesario finalizar la sesiĆ³n.
De esta manera evitaremos problemas de seguridad inhabilitando el token generado en el login del inicio.
MĆ©todo
CĆ³digo de ejemplo para jQuery
InformaciĆ³n relevante
Todos los WebServices son de tipo REST
uContact usa https por defecto (http2)
ConexiĆ³n CrossDomain
Con el Windows proxy podemos manejar eventos de un iframe insertado en un formulario, para poder por ejemplo hacer tipificaciones, colgar la llamada, cerrar el formulario o cualquier cosa que se desee.Ā
Para realizar esto no se necesita ningĆŗn plugin.
Pasos previos
En el formulario se debe poner:
event.data se puede usar para identificar de quĆ© tipo es la acciĆ³n.
Y el atributoĀ disposition se usa como un objeto para mandar mĆ”s informaciĆ³n.
ĀæCĆ³mo invocarlo?
La manera de invocarlo es:
CreaciĆ³n de tokens
Los usuarios con rol "SuperUsuario" en uContact tienen la funcionalidad de crear tokens para ser utilizados fuera de la aplicaciĆ³n. Para crear un token seguir los siguientes pasos:
Acceder al menĆŗ de usuario.
Ā
Seleccionar la opciĆ³n de "API tokens" en el menu desplegado y se abrirĆ” un modal para su creaciĆ³n.
Ā
Ingresar el nombre con el que quiere identificar el token y haga clic en el botĆ³n "Agregar" para crear un nuevo token.
Ā
Una vez que se ha creado un token en uContact, los āSuperUsuarioā tienen la posibilidad de compartirlo con otros usuarios. Para hacerlo, es necesario hacer clic en el icono del clip. De esta manera, el token se copiarĆ” automĆ”ticamente en el portapapeles y podrĆ” ser enviado a cualquier persona con la que se desee compartir.
Links de interƩs
ColecciĆ³n de postman para el inicio y cierre de sesiĆ³n.
Ā
Ā