Saltar al contenido
P4 Software P4 Software / activoHQ - Español

Agrega esta documentación a Claude

Hazle preguntas a Claude sobre esta documentación. Claude lee las páginas publicadas y te enlaza a ellas. Copia esta dirección:

https://p4-software.opendocs.page/mcp

En claude.ai o Claude Desktop: abre Configuración, luego Conectores, elige Agregar conector personalizado y pega la dirección.

En Claude Code, ejecuta:

claude mcp add --transport http docs https://p4-software.opendocs.page/mcp

API para desarrolladores

API REST para desarrolladores (descripcion general)

activoHQ expone una API REST en /api/v1 para que puedas integrar los datos de Activos fijos con tus propios sistemas, automatizar actualizaciones masivas o construir paneles personalizados. Esta pagina cubre todos los endpoints disponibles en la Fase 1.


Referencia de la API


URL base

https://{tenant}.activohq.cloud/api/v1

Reemplaza {tenant} con tu subdominio (p. ej. acme -> https://acme.activohq.cloud/api/v1). Todas las solicitudes estan limitadas al tenant identificado por el encabezado del host; no hay un segmento de tenant en la ruta.


Autenticacion

Cada solicitud a /api/v1 debe incluir una clave de API en el encabezado X-Api-Key.

X-Api-Key: ahq_your_key_here

Como obtener una clave: inicia sesion como Administrador, abre Mi perfil, busca el recuadro API para desarrolladores y haz clic en Generar clave de API. La clave queda guardada en ese recuadro: usa el icono del ojo para mostrarla u ocultarla y Copiar al portapapeles para copiarla. Las claves no caducan. Para rotar una clave comprometida usa Regenerar; para deshabilitar el acceso usa Revocar. El recuadro tambien tiene el enlace Ver referencia de la API, que abre la referencia interactiva en /developers de tu dominio.

La sección API para desarrolladores en Mi Perfil, con la clave enmascarada

Una clave ausente o invalida devuelve:

HTTP 401 Unauthorized

Alcance por empresa

Todos los endpoints, excepto GET /api/v1/companies, requieren un parametro de consulta companyId. Obtén los IDs de tu empresa desde GET /api/v1/companies.

Error Causa
400 El parametro no esta presente o no es un GUID valido. En ese caso la respuesta no trae el cuerpo error de la API. Si se envia el GUID vacio (todo ceros), el cuerpo es {"error":"companyId is required."}.
404 {"error":"Company not found."} El ID no corresponde a ninguna empresa activa de tu tenant.

Paginacion

Los endpoints de listado aceptan skip (predeterminado 0) y take (predeterminado 50, minimo 1, maximo 200; los valores fuera de rango se ajustan) y devuelven un sobre estandar:

{
  "items": [...],
  "total": 312,
  "skip": 0,
  "take": 50
}

Recorre el conjunto completo de resultados incrementando skip en el valor de take hasta que skip >= total.


Estructura de errores

Los errores de la API devuelven un estado distinto de 2xx y un cuerpo JSON pequeno (los mensajes estan en ingles):

{ "error": "Human-readable message." }
Estado Significado
400 Validacion fallida o regla de negocio incumplida. Si la solicitud esta mal formada (por ejemplo companyId ausente o un cuerpo que no es JSON valido), la respuesta puede no traer el cuerpo error.
401 X-Api-Key ausente o invalida. No trae cuerpo.
404 Recurso no encontrado.

Flujo de integracion tipico

  1. Llama a GET /api/v1/companies para obtener tu companyId.
  2. Llama a los endpoints de catalogos (/locations, /cost-centers, etc.) para mapear codigos a IDs.
  3. POST /api/v1/assets por cada activo nuevo. El modelo de activo (assetModelId) no tiene catalogo propio: tomalo del campo model.id de un activo existente.
  4. PUT /api/v1/assets/{id} para actualizar los existentes. El PUT reemplaza el registro completo: lee primero el activo con GET y reenvia todos los campos, porque los que omitas se borran.
  5. GET /api/v1/assets?search=... para consultar el registro.

Preguntas y soporte

Contacta a support@activohq.cloud o al administrador de tu instancia de activoHQ. Incluye la ruta, la fecha y hora de la llamada, el estado HTTP recibido y el payload exacto que enviaste (la API no devuelve un ID de solicitud).

¿Te resultó útil esta página?