API de distribuição

Leitura estimada: 3 minutos

API de distribuição de software (LAN)

Entrega automatizada de aplicativos internos

O módulo LAN Software Distribution API permite que sistemas externos se integrem ao CIQ ITAM para automatizar a entrega de software pela rede local (LAN). Com essa API, você pode enviar comandos para distribuir, instalar ou atualizar aplicativos em vários dispositivos diretamente de seu próprio aplicativo ou script.

Esse recurso é ideal para equipes de TI que buscam simplificar e padronizar processos de instalação de software em larga escala sem depender de etapas manuais ou interação direta com o console CIQ ITAM.

Por exemplo, uma central de serviços ou um sistema de emissão de tíquetes pode acionar automaticamente a implantação de um aplicativo aprovado em um computador assim que uma solicitação for enviada, reduzindo o tempo de resposta e garantindo a conformidade com as políticas internas de TI.

Ponto de extremidade: https://environment-smartcenter.almaden.app/api/distribution/api/auth

Método: POST

Parâmetros via corpo:

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

Método para retornar um dispositivo

Ponto de extremidade: 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 criar uma distribuição

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

Parâmetros via corpo:

{
"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 o status da distribuição

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

Possíveis respostas:

Descrição	Código	Resposta
Tarefa agendada, aguardando execução.	200	{ “status”: true, “data”: { “delivered”: “scheduled” } }
Tarefa em andamento.	200	{ “status”: true, “data”: { “startTime”: “2021-03-30 16:43:23.000000”, “delivered”: “running” } }
A distribuição foi realizada com sucesso.	200	{ “status”: true, “data”: { “startTime”: “2021-03-30 16:43:23.000000”, “stopTime”: “2021-03-30 16:43:40.000000”, “delivered”: “Y”, “error”: “” } }
Programação de tarefas de distribuição expirada.	400	{ “status” :false, “data” : {}, “error”: “Expired Job” }
Programação de tarefas de distribuição expirada.	400	{ “status” :false, “data” : {}, “error”: “Job not found” }
Token de acesso inválido.	403	{ “status”: false, “data”: {}, “error”: “Unauthorized access” }

API de distribuição