...
- Endpoint:
/acreditaciones/ejecutar
- Método:
POST
- Descripción: Ejecutar una acreditación.
- Headers:
API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
Request Body:
Code Block language py title json linenumbers true { "acreditacion": { "usuario": "test1", "idAcreditacion":274 } }
Expand title Consideraciones del Request "usuario" => Puede enviar el nombre del usuario que creo la acreditación para asociar esa información a la petición.
"idAcreditacion" => Debe enviar el ID de la orden de acreditación devuelta por el endpoint anterior.Response Body:
Code Block language py title json linenumbers true { "header": { "codReturn": 0, "txtReturn": "SUCCESS" }, "data": { "descripcion": "Se proceso correctamente" } }
Expand title Respuestas posibles "codReturn": 0, "txtReturn": "SUCCESS", "descripcion": "Se proceso correctamente" => Todos los colaboradores del Request pueden recibir su acreditación sin problemas.
"codReturn": 1, "txtReturn": "ERROR", "descripcion": "Hubo un problema al ejecutar la acreditacion" => El endpoint tuvo un problema procesando la petición. Sistemas ya fue notificado.
"codReturn": 2, "txtReturn": "ERROR", "descripcion": "No existe la orden de acreditacio" => Hay usuarios que no pertenecen a la lista de colabores de la empresa, pero si se procesa la orden para el resto.
"codReturn": 3, "txtReturn": "WARNING", "descripcion": "Esta orden de acreditacion ya fue ejecutada" => Todos los colabores del request, no pertenecen a la empresa.
"codReturn": 4, "txtReturn": "ERROR", "descripcion": "DINAMICO" => Se devuelve una descripción distinta dependiendo de la validación que rechazo la petición.
HistoricoAcreditaciones
- Endpoint:
/acreditaciones/historico
- Método:
POST
- Descripción: Devuelve los datos del histórico.
- Headers:
API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
Request Body:
Code Block language py title json linenumbers true { "acreditacion": { "usuario": "test1", "idAcreditacion":274 } }
Expand title Consideraciones del Request "fechaInicio" => Debe ser numérico, contener el número de documento de la persona a quien se le va a asociar como colaborador de la empresa.
"fechaFinal" => Debe tener ese formato, no debe contener caracteres especiales ni espacios.
"estado" => Valores posibles: APROBADO, APROBADO-EJECUTADO y PENDIENTE.Response Body:
Code Block language py title json linenumbers true { "header": { "codReturn": 0, "txtReturn": "SUCCESS" }, "data": [ { "descripcion": "Orden para Joel", "estado": "APROBADO", "fechaAprob": "03/09/2024 09:30:22", "fechaEjec": "03/09/24 09:30", "fechaInsert": "03/09/2024 09:30:22", "glosa": "ACREDITACION DE SALARIOS", "idAcreditacion": "570", "montoTotal": "1000000", "usuarioAprob": "test1", "usuarioEjec": "test1", "usuarioInsert": "test1" }, { "descripcion": "Orden Nro. 5500", "estado": "APROBADO", "fechaAprob": "02/09/2024 10:53:40", "fechaEjec": "02/09/24 10:53", "fechaInsert": "02/09/2024 10:53:40", "glosa": "ACREDITACION DE SALARIOS", "idAcreditacion": "568", "montoTotal": "1000000", "usuarioAprob": "test1", "usuarioEjec": "test1", "usuarioInsert": "test1" }, { "descripcion": "Joel acreditación", "estado": "APROBADO", "fechaAprob": "02/09/2024 10:52:23", "fechaEjec": "02/09/24 10:52", "fechaInsert": "02/09/2024 10:52:23", "glosa": "ACREDITACION DE SALARIOS", "idAcreditacion": "567", "montoTotal": "1000000", "usuarioAprob": "test1", "usuarioEjec": "test1", "usuarioInsert": "test1" }, { "descripcion": "Acreditación Joel", "estado": "APROBADO", "fechaAprob": "02/09/2024 10:51:10", "fechaEjec": "02/09/24 10:51", "fechaInsert": "02/09/2024 10:51:10", "glosa": "ACREDITACION DE SALARIOS", "idAcreditacion": "566", "montoTotal": "1000000", "usuarioAprob": "test1", "usuarioEjec": "test1", "usuarioInsert": "test1" } ] }
DisponibleCuentaEmpresa
- Endpoint:
/acreditaciones/disponible
- Método:
POST
- Descripción: Devuelve los datos de la cuenta.
- Headers:
API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
Request Body: (SIN REQUEST, SOLO POST)
Response Body:
Code Block language py title json linenumbers true { "data": { "disponible": "45075000", "estado": "Operativa", "nroCuenta": "", "nroTarjeta": "2C382210F8FE550D", "nroTarjetaCripto": "6043-XXXX-XXXX-6775" }, "header": { "codReturn": 0, "txtReturn": "SUCCESS" } }
Manejo de errores
- Common HTTP Status Codes:
200 OK
: The request was successful.400 Bad Request
: The request could not be understood or was missing required parameters.401 Unauthorized
: Authentication failed or user does not have permissions for the desired action.404 Not Found
: The requested resource could not be found.500 Internal Server Error
: An error occurred on the server.
...
Este documento proporciona una guía completa para la integración y uso de la API de Dimo Empresa. Asegúrate de seguir las mejores prácticas de seguridad y yo me comprometo a mantener actualizada la documentación para reflejar cualquier cambio en la API. |
| Versión de la doc: v1.0.01.0 |
---|
...