a. Seguridad API
- Ramiro Pereyra (Unlicensed)
- Anonymous
Todos los WebServices son de tipo REST
uContact usa https por defecto (http2)
Cualquier otro Servicio invocado sin ser estos deben tener el encabezado Authorization para funcionar.
Para poder usar la API se necesita
Autenticarse y obtener un token para la sesión.
Usar el token en el Heder Authorization
Finalizar sesión
Obtener APIKey
User
URL Relativa: Integra/resources/auth/UserLogin
Método: POST content-type:application/x-www-form-urlencoded; charset=UTF-8 Parámetros: user password
Resultado: JSON
Md5secret es la APIKey o si no tiene telefono llega en el Item 3 de la lista
Si es Error Respuesta 0
Código de ejemplo para jQuery.
AJAX Example
$.ajax({
type: 'POST',
url: 'https://<ucontactinstance>.ucontactcloud.com/Integra/resources/auth/UserLogin',
contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
dataType: 'text',
data: {
user: 'ExampleUsername',
password: 'ExamplePassword'
},
success: (resp) => {},
error: (resp) => {}
});
Usar token en las consultas a la API
Se puede configurar jQuery para que use el token en cada petición.
AJAX Example
$.ajaxSetup({
headers: {
'Authorization': "Basic " + APIKey
}
});Sino, se puede especificar en los headers en cada petición que se haga.
AJAX Example UserLogin
$.ajax({
type: 'POST',
url: 'https://<ucontactinstance>.ucontactcloud.com/Integra/resources/any/request',
contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
dataType: 'text',
headers:{
'Authorization': 'Basic <APIKey>'
},
data: {
param1: 'exampleParam1',
param2: 'exampleParam2'
},
success: (resp) => {},
error: (resp) => {}
});Finalizar sesión
Con este método se finaliza con la vida de un token
User
Relative URL: Integra/resources/auth/EndSession
Method: POST content-type:application/x-www-form-urlencoded; charset=UTF-8 Params: user
token
Result: 1 OK 0 ERROR
Este servicio termine
Código de ejemplo para jQuery.
AJAX Example EndSession