Dimo Empresa - API

...

Documentation

Base URLs

• LocalHost: http://localhost:8080/ApiDimoEmpresaJavaEnvironment/rest
• 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

LocalHost

...

AltaColaborador

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

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

• Response: No response example provided.

...

ListarColaborador

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

...

3. CrearAcreditacion

...

• API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

...

4. EjecutarAcreditacion

...

• API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

...

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

...

ListarColaborador

...

CrearAcreditacion

...

EjecutarAcreditacion

...

Este documento proporciona una descripción clara y concisa de la API de "Dimo Empresa", con ejemplos prácticos para cada uno de los endpoints disponibles. Para cualquier actualización o modificación, asegúrate de mantener esta documentación sincronizada con los cambios en la API.

Si necesitas integrarlo con una plataforma de documentación interactiva como Swagger, Postman o cualquier otra, aquí tienes algunos pasos generales para hacerlo:

Integración con Swagger/OpenAPI

1. Crear un archivo de especificación OpenAPI: Este archivo (swagger.yaml o swagger.json) contendrá todas las definiciones de tu API.
2. Generar la documentación: Puedes usar herramientas como Swagger UI para generar una interfaz interactiva.

Ejemplo de Especificación OpenAPI (YAML)

...

Integración con Postman

1. Importar el archivo JSON: En Postman, puedes importar el archivo JSON directamente para obtener una colección con todos los endpoints definidos.
2. Generar documentación: Postman permite generar documentación interactiva y publicarla en línea.

Publicación en GitHub Pages o GitBook

1. Markdown documentation: Puedes convertir esta documentación en formato Markdown y publicarla en plataformas como GitHub Pages o GitBook para una presentación atractiva y accesible.

...

• Response: No response example provided.

ListarColaborador

...

• API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

...

CrearAcreditacion

...

• API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

...

EjecutarAcreditacion

...

• API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

...

PreProducción

API-KEY - Validar

• Endpoint: /auth/realms/mdw/check
• Method: GET
• Description: Validates an API key.
• Headers: None required.
• URL Parameters:
  • `apiKey: t7DQWbMzns339c9CA4rt7FBByqhYKd94

AVW0MamEuSOfjV9c3A`

• Response: No response example provided.

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

...

ListarColaborador

...

CrearAcreditacion

...

EjecutarAcreditacion

...

API-KEY - Validar

...

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.

{
    "nroDocumento": 4040440
}