InVeloz

Contenido

Administración

RestAPI

Inventory Pro incluye una API REST opcional que permite integraciones de terceros, herramientas de reportes y scripts de automatizaci\u00f3n para leer y escribir datos programaticamente. La API no está habilitada por defecto - debe desplegarse y configurarse como una aplicaci\u00f3n IIS separada. Contacte a CISS Ltd. para habilitarla en su instalaci\u00f3n.

Referencia Rapida

ElementoValor
URL Basehttps://<su_sistema>/api/v1
Documentaci\u00f3nhttps://<su_sistema>/api/v1/swagger
Autenticaci\u00f3nOAuth 2.0 Client Credentials
Estado por defectoDeshabilitada - requiere despliegue por CISS
TransporteHTTPS requerido

Disponibilidad

La API es una aplicaci\u00f3n separada que se despliega junto a la aplicaci\u00f3n Desktop. No esta presente en todas las instalaciones. Si su organizaci\u00f3n no la ha habilitado, todos los endpoints devolveran errores 404 o de conexión.

Cuando esta desplegada, la URL base de la API sigue este patrón:

https://<su_sistema>/api/v1

La documentaci\u00f3n interactiva (Swagger UI) está disponible en:

https://<su_sistema>/api/v1/swagger

La página de Swagger lista todos los endpoints disponibles, parámetros aceptados y esquemas de respuesta para su despliegue específico. Es la referencia autoritativa para la version de la API en su instalaci\u00f3n.

Autenticacion

La API usa credenciales de cliente OAuth 2.0. Antes de realizar cualquier solicitud:

  1. Solicite credenciales de API (client ID y client secret) a su administrador de sistema o a CISS Ltd.
  2. Envíe un POST al endpoint /Token:
    • grant_type: client_credentials
    • client_id: su client ID asignado
    • client_secret: su client secret asignado
  3. Use el token bearer devuelto en el encabezado Authorization de todas las solicitudes subsiguientes:
    Authorization: Bearer <token>

Las solicitudes no autenticadas devuelven HTTP 401.

Cobertura de Endpoints

Cuando esta desplegada, la API proporciona endpoints en estos grupos de recursos:

Grupo de RecursosOperaciones Disponibles
AssetObtener por ID, listar todos, obtener tipos, eliminar
CategoryObtener por ID, listar todos, eliminar
CustomerObtener por ID, listar todos, eliminar
InventoryObtener por ID, niveles de stock, material entrada/salida
ItemObtener por ID, listar todos, crear, actualizar, eliminar, alias
LocationObtener por ID, bloquear, liberar
Purchase OrderObtener por ID, crear
Reason CodeObtener por ID, listar todos, eliminar
Shipping OrderObtener por ID, crear
VendorObtener por ID, listar todos, eliminar
WarehouseObtener por ID, artículos, inventario, ubicaciones, niveles de stock
Work OrderObtener por ID

Para firmas exactas de endpoints, formatos de solicitud/respuesta y disponibilidad actual, consulte la interfaz Swagger en su instancia desplegada o la Referencia de API.

Referencia de API

Para documentaci\u00f3n completa de desarrollo incluyendo flujos de autenticaci\u00f3n, manejo de errores, paginaci\u00f3n y guías por endpoint:

Referencia de API →

Temas Relacionados

En esta página