Contenido
Inventory Pro incluye una API REST opcional que permite integraciones de terceros, herramientas de reportes y scripts de automatizacion para leer y escribir datos programaticamente. La API no esta habilitada por defecto - debe desplegarse y configurarse como una aplicacion IIS separada. Contacte a CISS Ltd. para habilitarla en su instalacion.
| Elemento | Valor |
|---|---|
| URL Base | https://<su_sistema>/api/v1 |
| Documentacion | https://<su_sistema>/api/v1/swagger |
| Autenticacion | OAuth 2.0 Client Credentials |
| Estado por defecto | Deshabilitada - requiere despliegue por CISS |
| Transporte | HTTPS requerido |
La API es una aplicacion separada que se despliega junto a la aplicacion Desktop. No esta presente en todas las instalaciones. Si su organizacion no la ha habilitado, todos los endpoints devolveran errores 404 o de conexion.
Cuando esta desplegada, la URL base de la API sigue este patron:
https://<su_sistema>/api/v1La documentacion interactiva (Swagger UI) esta disponible en:
https://<su_sistema>/api/v1/swaggerLa pagina de Swagger lista todos los endpoints disponibles, parametros aceptados y esquemas de respuesta para su despliegue especifico. Es la referencia autoritativa para la version de la API en su instalacion.
La API usa credenciales de cliente OAuth 2.0. Antes de realizar cualquier solicitud:
/Token:grant_type: client_credentialsclient_id: su client ID asignadoclient_secret: su client secret asignadoAuthorization de todas las solicitudes subsiguientes:Authorization: Bearer <token>Las solicitudes no autenticadas devuelven HTTP 401.
Cuando esta desplegada, la API proporciona endpoints en estos grupos de recursos:
| Grupo de Recursos | Operaciones Disponibles |
|---|---|
| Asset | Obtener por ID, listar todos, obtener tipos, eliminar |
| Category | Obtener por ID, listar todos, eliminar |
| Customer | Obtener por ID, listar todos, eliminar |
| Inventory | Obtener por ID, niveles de stock, material entrada/salida |
| Item | Obtener por ID, listar todos, crear, actualizar, eliminar, alias |
| Location | Obtener por ID, bloquear, liberar |
| Purchase Order | Obtener por ID, crear |
| Reason Code | Obtener por ID, listar todos, eliminar |
| Shipping Order | Obtener por ID, crear |
| Vendor | Obtener por ID, listar todos, eliminar |
| Warehouse | Obtener por ID, articulos, inventario, ubicaciones, niveles de stock |
| Work Order | Obtener 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.
Para documentacion completa de desarrollo incluyendo flujos de autenticacion, manejo de errores, paginacion y guias por endpoint:
En esta página