Dimo Empresa - API Documentation

Base URLs

PreProducción: http://10.5.1.31:9087

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:

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

Response: No response example provided.

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

ListarColaborador

Endpoint: /colaboradores/listar
Method: POST
Description: Lists a collaborator by document number.
Headers:
- API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
Request Body:
{ "nroDocumento": 4040440 }

Response Body:

{
    "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"
        }
    ]
}

CrearAcreditacion

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

Request Body:

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

Response Body:

{
    "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"
            }
        ]
    }
}

EjecutarAcreditacion

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

Request Body:

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

Response Body:

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

Error Handling

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.

Example Usage

Here are some example requests using curl:

AltaColaborador

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

ListarColaborador

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

CrearAcreditacion

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

EjecutarAcreditacion

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

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.