API de distribución

Lectura estimada: 3 minutos

📦 API de distribución de software (LAN)

Entrega automatizada de aplicaciones internas

El módulo LAN Software Distribution API permite que sistemas externos se integren con CIQ ITAM para automatizar la distribución de software a través de la red local (LAN). Con esta API, puede enviar comandos para distribuir, instalar o actualizar aplicaciones a través de múltiples dispositivos directamente desde su propia aplicación o script.

Esta función es ideal para los equipos de TI que buscan agilizar y estandarizar los procesos de instalación de software a gran escala sin depender de pasos manuales o de la interacción directa con la consola CIQ ITAM.

Por ejemplo, un servicio de atención al cliente o un sistema de tickets puede activar automáticamente la implantación de una aplicación aprobada en un ordenador en cuanto se envía una solicitud, lo que reduce el tiempo de respuesta y garantiza el cumplimiento de las políticas internas de TI.

Punto final: https://environment-smartcenter.almaden.app/api/distribution/api/auth

Método: POST

Parámetros a través del cuerpo:

{
“automatosId”: “123456789”, “automatosKey”: “ABCDEFGH=”
}
 
response code(200):
 
{
“status”: true, “data”: {
“token”: “ABCDEF12345”
}
}
 
response code(400):
 
{
“status”: false, “data”: {},
“error”: “invalid credential”
}

Método para devolver un dispositivo

Punto final: https://environment-smartcenter.almaden.app/api/distribution/api/machine?hostname=NTB1

Método: GET
Header Autorization: “Bearer <token>”
Parameter via url: hostname=NTB1
Resposta code(200)

{
"status": true, "data": {
"machines": [
{
"machineId": "123ABC", "hostname": "NTB1", "department": "DEV"
},
{
 
"machineId": "ABC987",
"hostname": "NTB1", "department": "Comercial"
},
]
}
}

response code(400)
{
"status": false, "data": {},
"error": "machine not found"
}

Método para crear una distribución

Endpoint: https:// environment-smartcenter.almaden.app/api/distribution/api/express/distribution
Método: POST
Header Autorization: “Bearer <token>”

Parámetros a través del cuerpo:

{
"machineId" : "123ABC", "package" : "7zip.exe", "domain" : "AUTOMATOS",
"user" : "user",
"password" : "pass", "irradiadora" : "0050568"
}

response code(200)

{
"status" : true, "data" : {
"jobName" : "ASDF123456"
}
}

response code(400)

{
"status": false, "data": {},
"error": "Something went wrong"
}

Método para consultar el estado de la distribución

Endpoint: https://environment-smartcenter.almaden.app/api/distribution/api/express/distribution?jobName=ASDF123456
Method: GET
Header Autorization: “Bearer <token>”
Parameter via url: jobName= ASDF123456

Posibles respuestas:

Descripción	Código	Respuesta
Tarea programada, a la espera de ejecutarse.	200	{ “status”: true, “data”: { “delivered”: “scheduled” } }
Tarea en curso.	200	{ “status”: true, “data”: { “startTime”: “2021-03-30 16:43:23.000000”, “delivered”: “running” } }
Distribución realizada con éxito.	200	{ “status”: true, “data”: { “startTime”: “2021-03-30 16:43:23.000000”, “stopTime”: “2021-03-30 16:43:40.000000”, “delivered”: “Y”, “error”: “” } }
Programación de tareas de distribución caducada.	400	{ “status” :false, “data” : {}, “error”: “Expired Job” }
Programación de tareas de distribución caducada.	400	{ “status” :false, “data” : {}, “error”: “Job not found” }
Token de acceso inválido.	403	{ “status”: false, “data”: {}, “error”: “Unauthorized access” }

API de distribución