...
Integraciones

API públicas de CIQ ITAM

Lectura estimada: 6 minutos

API pública de Collective IQ

Integración y automatización simplificadas

El módulo CIQ ITAM Public API proporciona APIs para consultar información sobre Hardware, Software, Rendimiento y más. Permite a los sistemas externos acceder a los datos directamente desde CIQ ITAM. A través de esta API, es posible automatizar consultas, actualizaciones e integraciones con otras herramientas de gestión de TI.

Esta funcionalidad es esencial para las empresas que buscan mejorar la eficacia de los procesos eliminando las acciones manuales repetitivas y permitiendo la creación de flujos de trabajo personalizados.

Con la API pública deCIQ ITAM, su equipo de TI puede integrar los datos y comandos de CIQ ITAM con sistemas como ERPs, plataformas de monitorización o scripts internos, optimizando la gestión y promoviendo una mayor agilidad y precisión operativa.

Las API públicas CIQ ponen a disposición todos los datos de inventario y ofrecen la opción de extraerlos en un informe, que se entrega en formato JSON.
Se pueden utilizar para la integración con herramientas que realizan llamadas a la API REST y aceptan JSON como tipo de datos de salida.

Imagen 398 API públicas de CIQ
Menú > Integraciones > API pública de CIQ

Capacidades de consulta

La API pública de Collective IQ está basada en REST y proporciona múltiples puntos finales, cada uno segmentado por tipo de datos. Cada segmento que se muestra a continuación representa una URL específica, lo que permite realizar consultas específicas según el dominio de datos deseado.

Las respuestas se devuelven en formato JSON, y los campos que se enumeran a continuación representan exactamente lo que se puede consultar, independientemente de los valores devueltos por cada dispositivo.

Datos de hardware (estaciones de trabajo)

Terminal dedicado al inventario de ordenadores de sobremesa y portátiles.

Campos de consulta disponibles:
computer_name; 
department_name; 
department_hierarchy; 
so_string; 
so_version; 
system_manufacturer; 
computer_type; 
machine_net_ipaddress; 
bios_release_date; 
machine_ipdomain; 
is_virtual_machine; 
system_product_name; 
system_serial_number; 
machine_id; 
os_bits; 
login_name; 
cpu_identity; 
cpu_generation; 
cpu_type; 
cpu_clock; 
cpu_clock_in_MHz; 
cpu_clock_in_GHz; 
core_num; 
physical_cpu_amount; 
logical_cpu; 
memory_range; 
installed_mem; 
disk_total; 
disk_used; 
top_user; 
percent_top_user; 
dns_servers; 
machine_gateway; 
collect_date; 
status; 
installed_agent_type; 
installed_agent_version; 
update_date; 
last_login; 
installed_mem_in_GB; 
disk_total_in_GB; 
disk_used_in_GB; 
installed_mem_in_MB; 
disk_total_in_MB; 
disk_used_in_MB

Software (estaciones de trabajo)

Terminal dedicado al inventario del software instalado en las estaciones de trabajo.

Campos de consulta disponibles:
sw_id; 
computer_name; 
department_name; 
software_name; 
normalized_software_name; 
is_licensable; 
software_version; 
software_manufacturer; 
homologation_status; 
instalation_date; 
machine_type; 
machine_id; 
family; 
label; 
category_name; 
category_description; 
group_name; 
group_description; 
register_key

Monitor

Punto final responsable de la información relacionada con los monitores asociados a las estaciones de trabajo.

Campos de consulta disponibles:

machine_id; 
computer_name; 
computer_type; 
collect_time; 
department_name; 
so_string; 
system_serial_number; 
monitors

Hardware del servidor

Terminal dedicado al inventario de servidores físicos y virtuales.

Campos de consulta disponibles:
computer_name; 
department_name; 
so_string; 
so_version; 
system_manufacturer; 
computer_type; 
machine_net_ipaddress;
bios_release_date; 
machine_ipdomain; 
is_virtual_machine; 
system_product_name; 
system_serial_number; 
machine_id; 
cpu_identity; 
cpu_generation; cpu_type; 
cpu_clock; 
cpu_clock_in_MHz; 
cpu_clock_in_GHz; 
core_num; 
cpu_quantity; 
cpu_active;
memory_range; 
installed_mem;
disk_total; 
disk_used; 
collect_date; 
status; 
installed_agent_type; 
installed_agent_version; 
update_date; 
installed_mem_in_GB; 
disk_total_in_GB; 
disk_used_in_GB; 
installed_mem_in_MB; 
disk_total_in_MB; 
disk_used_in_MB; 
os_bits

Software de servidor

Punto final dedicado al inventario del software instalado en los servidores.

Campos de consulta disponibles:
sw_id; 
computer_name; 
department_name; 
software_name; 
normalized_software_name; 
is_licensable; 
software_version; 
software_manufacturer; 
homologation_status; 
instalation_date; 
machine_type; 
machine_id; 
family; 
label; 
category_name; 
category_description; 
group_name; 
group_description

SNMP

Punto final para consultar dispositivos de red supervisados a través de SNMP, como conmutadores y enrutadores.

Campos de consulta disponibles:

Campos de consulta disponibles:
name; 
object_id; 
ip_address; 
department_name; 
contact; 
location; 
monitored_by; 
machine_id; 
dns_name; 
up_time; 
agent_id; 
description; 
interfaces

Campos de interfaz disponibles:
interface_name; 
index; 
ip_address; 
type; 
mtu; 
speed; 
admin_status; 
operational_status; 
mac_address

Formulario personalizado – Estaciones de trabajo

Punto final dinámico basado en formularios personalizados creados por el usuario para estaciones de trabajo.

Características:
  • Los campos devueltos por la API corresponden exactamente a los campos definidos por el usuario en la plataforma.
  • Estructura flexible sin esquema fijo.

Formulario personalizado – Servidores

Punto final dinámico basado en formularios personalizados creados por el usuario para servidores.

Características:
  • Los campos expuestos por la API reflejan completamente los campos configurados por el usuario.
  • Permite enriquecer el inventario estándar del servidor.

Rendimiento del escritorio: detalles generales

Punto final que proporciona indicadores generales consolidados de rendimiento para estaciones de trabajo.

Campos de consulta disponibles:
machine_id; 
computer_name; 
login_name; 
department_name; 
avg_cpu; 
avg_mem; 
perc_disk

Rendimiento del escritorio: proceso de la CPU

Endpoint centrado en el consumo de CPU por proceso en estaciones de trabajo.

Campos de consulta disponibles:
machineId; 
loginName; 
computerName; 
process; 
value

Rendimiento del escritorio: proceso de memoria

Endpoint se centró en el consumo de memoria por proceso en las estaciones de trabajo.

Campos de consulta disponibles:
machineId; 
loginName; 
computerName; 
process; 
value

Software de inventario – Licencias

Punto final centrado en las licencias de software. Permite recuperar información sobre licencias de software mediante GET y actualizar los detalles de las licencias de software mediante POST.

Campos de consulta disponibles GET:
Obtenga una lista completa del software instalado en su cuenta. Puede filtrar por nombre del software y estado de aprobación.
search; (Filter by software name. Type any part of the text and the search will return all records that contain it, without the need for wildcard characters like *.)

approved; (Filter by software approval status. You should fill this field with 'true' if you want to filter software with an approved status.)

obsolete; (Filter by software approval status. You should fill this field with 'true' if you want to filter software with an obsolete status.)

unapproved; (Filter by software approval status. You should fill this field with 'true' if you want to filter software with an unapproved status.)

unknown; (Filter by software approval status. You should fill this field with 'true' if you want to filter software with an unknown status.)

Campos de consulta disponibles POST:
Puede filtrar por rango de fechas, tipo de evento (eliminado, instalado, presente) y buscar por parte del nombre del software.
machineId;

Example Body:
{
  "startDate": "2026-02-10",
  "endDate": "2026-02-20",
  "search": "notepad",
  "event": [
    "removed",
    "installed"
  ]
}

Response 200:
[
  {
    "machineId": "123456789",
    "machineName": "DEVICE",
    "date": "20/02/2026 16:42",
    "event": "removed",
    "software": "Notepad++ (64-bit x64)",
    "version": "8.9",
    "manufacturer": "Notepad++ Team",
    "currentUser": "user"
  }
]

Campos de consulta disponibles POST:
Puede crear o actualizar el estado de aprobación de uno o varios programas y describir el motivo del nuevo estado.
No Parameters

Example Body:
{
  "listSwId": [
    123,
    321
  ],
  "status": "unapproved",
  "reason": "Reason for approval"
}

Response 200:
{
  "status": true
}

Collective IQ – SWAGGER

Las API públicas de Collective IQ ®ITAM están documentadas utilizando Swagger:
LAD1: almaden
LAD2: almaden

API públicas de SmartCenter API públicas de CIQ ITAM

Compartir este documento

API públicas de CIQ ITAM

O copie el enlace

Índice
Ir arriba