Dimo Empresa - API Documentation

Base URLs

• PreProducción: http://10.5.1.30:8084/apidimoempresa/rest

Authentication

• API Key: All endpoints require an API key passed in the headers.
  • Header: API-KEY
  • Example Value: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

Endpoints

AltaColaborador

• Endpoint: /colaboradores/alta
• Method: POST
• Description: Creates a new collaborator.
• Headers:
  • API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

• Request Body:

  json

  {
      "colaborador": {
          "nroDocumento": 4040440,
          "nombres": "Arturo",
          "apellidos": "Sosa Bagnoli",
          "nroTelefono": "0971159618",
          "correo": "asosa@cabal.com.py"
      }
  }

   Consideraciones del Request

  "nroDocumento" => 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

  "nroTelefono" => Debe tener ese formato, no debe contener caracteres especiales ni espacios

  "correo" => Debe ser un correo valido

• Response:

  json

  {
      "header": {
          "codReturn": 3,
          "txtReturn": "WARNING"
      },
  	"data": {
          "info": "El colaborador ya existe",
          "nroTarjeta": "",
          "tarjetaMask": ""
      }
  }

   Respuestas posibles

  asdasdasd

ListarColaborador

• Endpoint: /colaboradores/listar
• Method: POST
• Description: Lists a collaborator by document number.
• Headers:
  • API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

• Request Body:

  json

  {
      "nroDocumento": 4040440
  }

   Consideraciones del Request

  "nroDocumento" => 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

  "nroTelefono" => Debe tener ese formato, no debe contener caracteres especiales ni espacios

  "correo" => Debe ser un correo valido

• Response Body:

  json

  {
      "header": {
          "codReturn": 0,
          "txtReturn": "SUCCESS"
      },
      "data": [
          {
              "apellidos": "Sosa",
              "correo": "asosa@cabal.com.py",
              "documento": "4040440",
              "estado": "Usuario registrado",
              "nombres": "Arturo",
              "nroTarjeta": "6043512000595678",
              "nroTelefono": "0986215487",
              "tarjetaMask": "6043-XXXX-XXXX-5678"
          }
      ]
  }

   Respuestas posibles

  asdasdasd

CrearAcreditacion

• Endpoint: /acreditaciones/crear
• Method: POST
• Description: Creates a new accreditation.
• Headers:
  • API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

• Request Body:

  json

  {
      "acreditacion": {
          "usuario": "test1",
          "descripcion":"prueba 1",
          "lista": [
              {
                  "nroDocumento": 4040440,
                  "monto": 1500000
              },
              {
                  "nroDocumento": 4040440,
                  "monto": 1200000
              },
              {
                  "nroDocumento": 404011111,
                  "monto": 1600000
              }
          ]
      }
  }

   Consideraciones del Request

  "nroDocumento" => 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

  "nroTelefono" => Debe tener ese formato, no debe contener caracteres especiales ni espacios

  "correo" => Debe ser un correo valido

• Response Body:

  json

  {
      "header": {
          "codReturn": 1,
          "txtReturn": "WARNING"
      },
      "data": {
          "estadoAcreditacion": "APROBADO",
          "idAcreditacion": "274",
          "acreditacionesValidas": [
              {
                  "estado": "Usuario registrado",
                  "monto": "1500000",
                  "nroDocumento": "4040440"
              },
              {
                  "estado": "Usuario registrado",
                  "monto": "1200000",
                  "nroDocumento": "4040440"
              }
          ],
          "acreditacionesNoValidas": [
              {
                  "estado": "No esta registrado como colaborador",
                  "monto": "1600000",
                  "nroDocumento": "404011111"
              }
          ]
      }
  }

   Respuestas posibles

  asdasdasd

EjecutarAcreditacion

• Endpoint: /acreditaciones/ejecutar
• Method: POST
• Description: Executes an accreditation.
• Headers:
  • API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

• Request Body:

  json

  {
      "acreditacion": {
          "usuario": "test1",
          "idAcreditacion":274
      }
  }

   Consideraciones del Request

  "nroDocumento" => 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

  "nroTelefono" => Debe tener ese formato, no debe contener caracteres especiales ni espacios

  "correo" => Debe ser un correo valido

• Response Body:

  json

  {
      "header": {
          "codReturn": 0,
          "txtReturn": "SUCCESS"
      },
      "data": {
          "descripcion": "Se proceso correctamente"
      }
  }

   Respuestas posibles

  asdasdasd

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://localhost:8080/ApiDimoEmpresaJavaEnvironment/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://localhost:8080/ApiDimoEmpresaJavaEnvironment/rest/colaboradores/listar" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
  "nroDocumento": 4040440
}'

CrearAcreditacion

curl -X POST "http://localhost:8080/ApiDimoEmpresaJavaEnvironment/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://localhost:8080/ApiDimoEmpresaJavaEnvironment/rest/acreditaciones/ejecutar" \
-H "API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled" \
-H "Content-Type: application/json" \
-d '{
  "acreditacion": {
    "usuario": "test1",
    "idAcreditacion": 274
  }
}'

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 mantener actualizada la documentación para reflejar cualquier cambio en la API.