Page History

Aquí tienes la documentación de la API basada en el archivo JSON proporcionado, estructurada para que sea clara y fácil de seguir.

Dimo Empresa - API

...

Documentación

Base URLs

• LocalHost: http://localhost:8080/ApiDimoEmpresaJavaEnvironment/rest
• PreProducción: http://10.5.1.31:9087

...

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

...

Endpoints

...

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

...

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

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

• Response: No response example provided.

PreProducción

1. API-KEY - Validar

• Endpoint: /auth/realms/mdw/check
• Method: GET
• Description: Validates an API key.

• Headers: None required.
• URL Parameters:
  • apiKey: t7DQWbMzns339c9CA4rt7FBByqhYKd94AVW0MamEuSOfjV9c3A
• Response: No response example provided.

...

sh

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
  }
}'

API-KEY - Validar

sh

curl -X GET
"http://10.5.1.31:9087/auth/realms/mdw/check?apiKey=t7DQWbMzns339c9CA4rt7FBByqhYKd94AVW0MamEuSOfjV9c3A"

...

Este documento proporciona unadescripción 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.

...

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

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

• Response: No response example provided.

PreProducción

API-KEY - Validar

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

...

sh

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
  }
}'

API-KEY - Validar

sh

curl -X GET "http://10.5.1.31:9087/auth/realms/mdw/check?apiKey=t7DQWbMzns339c9CA4rt7FBByqhYKd94AVW0MamEuSOfjV9c3A"

...