Dimo Empresa - API Documentation

Base URLs

• PreProducción:  http://10.5.1.3031:80848103/apidimoempresa/rest

Authentication

• API Key: Todos los endPoints necesitan un ApiKey en el header.
  • Header: API-KEY
  • Valor de ejemplo: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
  • Descripción: Aparte de seguridad por esta clave se identifica a la Empresa.

...

• 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.

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.

Ejemplos de uso

Ejemplos de como consumir por curl:

AltaColaborador

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

...

• {

...

...

• "filtros"

...

• :

...

• { "fechaInicio": "01/09/2024", "fechaFinal": "11/09/2024",

...

...

...

• "

...

• estado": "

...

• APROBADO"

...

...

ListarColaborador

curl -X POST "http://localhost:8080/ApiDimoEmpresaJavaEnvironment/rest/colaboradores/listar" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
  "nroDocumento": 4040440
}'

CrearAcreditacion

...

...

• } }

  Expand
  title Consideraciones del Request
  "fechaInicio" => Debe tener el formato de "dd/mm/yyyy" "fechaFinal" => Debe tener el formato de "dd/mm/yyyy" "estado" => Valores posibles: APROBADO, APROBADO-EJECUTADO y PENDIENTE. Se puede enviar uno o todos los campos vacios => "" Esto devolverá todos los registros.

• 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.

Ejemplos de uso

Ejemplos de como consumir por curl:

AltaColaborador

curl -X POST "http://10.5.1.31:8103/rest/colaboradores/alta" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
  "data": {
    "nroDocumento": 4040440,
    "nombres": "Arturo",
    "apellidos": "Sosa Bagnoli",
    "nroTelefono": "0971159618",
    "correo": "asosa@cabal.com.py"
  }
}'

ListarColaborador

curl -X POST "http://10.5.1.31:8103/rest/colaboradores/listar" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
  "nroDocumento": 4040440
}'

CrearAcreditacion

curl -X POST "http://10.5.1.31:8103/rest/acreditaciones/crear" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
  "acreditacion": {
    "usuario": "test1",
    "descripcion": "prueba 1",
    "lista": [
      {
        "nroDocumento": 4040440,
        "monto": 1500000
      },
      {
        "nroDocumento": 4040440,
        "monto": 1200000
      },
      {
        "nroDocumento": 404011111,
        "monto": 1600000
      }
    ]
  }
}'

EjecutarAcreditacion

curl -X POST "http://10.5.1.31:8103/rest/acreditaciones/ejecutar" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
  "acreditacion": {
    "usuario": "test1",
    "idAcreditacion": 274
  }
}'

HistoricoAcreditacion

curl -X POST "http://10.5.1.31:8103/rest/acreditaciones/historico" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
    "filtros": {
        "nroDocumentofechaInicio": 404011111"01/09/2024",
        "montofechaFinal": 1600000"11/09/2024",
      }  "estado": "APROBADO"
 ]   }
}'

...

ConsultarDisponible

curl -X POST "http://localhost:8080/ApiDimoEmpresaJavaEnvironment///10.5.1.31:8103/rest/acreditaciones/ejecutardisponible" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
  "acreditacion": {
    "usuario": "test1",
    "idAcreditacion": 274
  }
}'