Descripción general de la API

URL base

https://client-omni-api.argosidentity.com/v1

Si su organización restringe el tráfico saliente mediante firewall o proxy, añada client-omni-api.argosidentity.com a su lista de permitidos para HTTPS (puerto 443).

Autenticación

Todas las solicitudes requieren el header x-api-key:

-H "x-api-key: your-api-key-here"

Consulte Autenticación para ver cómo obtener su API key.

Estructura de la API

La Omni API sigue la siguiente jerarquía de datos:

Project → Workflow → Profile → Folder → Item → Analysis

Recurso	Endpoints principales
Project	`GET /v1/projects/:projectId`
Workflow	`GET /v1/workflows/:workflowId`
Profile	`POST`, `GET`, `PATCH`, `DELETE`
Folder	`POST`, `GET`, `PATCH`, `DELETE`
Item	`POST` (upload), `GET`, `PATCH`, `DELETE`

Formato de respuesta

Los endpoints de consulta (GET) devuelven el objeto del recurso directamente. No hay campo envoltorio.

{
  "id": "proj_6h4y8s2f0v9n",
  "name": "Compliance Production",
  "status": "trial"
}

El cuerpo de respuesta de las operaciones de creación, modificación y borrado puede variar según el endpoint. Consulte el ejemplo de respuesta en la página de cada endpoint.

Formato de respuesta de error

{
  "error": {
    "code": "ERROR_CODE",
    "status": 400,
    "message": "Human-readable error description"
  }
}

Códigos de error

Status	Code	Descripción
401	`UNAUTHORIZED`	API key inválida o ausente
404	`NOT_FOUND`	El recurso no existe
409	`CONFLICT`	Recurso duplicado o límite excedido
413	`PAYLOAD_TOO_LARGE`	El tamaño del archivo supera el límite de 10MB
415	`UNSUPPORTED_MEDIA`	Tipo de archivo no compatible

Códigos de error específicos por recurso

Code	Descripción
`ITEM_LIMIT_EXCEEDED`	Hay más de 5 items en una sola carpeta
`FILE_TOO_LARGE`	El archivo subido supera los 10MB
`UNSUPPORTED_FILE_TYPE`	El formato del archivo no está en la lista de compatibles

Paginación

Los endpoints de lista devuelven resultados paginados con un tamaño de página predeterminado de 50 items.

GET /v1/workflows/{workflowId}/profiles?page=1&size=50