API Departamentos v1

Descripción general

Recurso de la capa de experiencia encargado de recuperar información de departamentos desde el servicio BotService. Registra las solicitudes y respuestas, y captura datos clave para auditoría y control.

Categoría de Negocio: Movilidad

---

Capa de experiencia

Endpoint y método

GET [https://bot-xapi-services-qa.us-e2.cloudhub.io/v1/parameters/departments](https://bot-xapi-services-qa.us-e2.cloudhub.io/v1/parameters/departments)

Especificación (enlace si existe)

Ver en Anypoint Exchange

Descripción funcional

Consulta el listado de departamentos disponibles y sus datos asociados, integrándose con BotService para auditoría y control del consumo.

---

Capa de proceso

No aplica.

---

Capa de sistema

Endpoint y método

POST [https://bot-sapi-services-dev.us-e2.cloudhub.io/bot/parameters/departments/v1](https://bot-sapi-services-dev.us-e2.cloudhub.io/bot/parameters/departments/v1)

Especificación

Ver en Anypoint Exchange

Descripción funcional

Consulta directamente el servicio BotService para recuperar información de departamentos. Realiza la llamada interna a:

[http://botdev.portallteqa.p.azurewebsites.net/api/parameters/v1/getdepartments](http://botdev.portallteqa.p.azurewebsites.net/api/parameters/v1/getdepartments)

---

Ejemplos de Request/Response

Solicitud (request)

GET https://bot-xapi-services-qa.us-e2.cloudhub.io/v1/parameters/departments

Respuesta exitosa (200)

{
  "responseHeader": {
    "system": {
      "name": "Tienda",
      "correlationID": "TIENDA-2025-06-11-10-16-57-e3060a3b-29b89d79-c880b647-c4bf4dfe",
      "processingServer": "Tienda"
    },
    "service": {
      "status": "OK",
      "responseDate": "2025-06-15T15:49:46.1028033Z",
      "statusDetail": [
        {
          "errorCode": "OK_01",
          "errorDetailCode": "Se consultaron los departamentos exitosamente",
          "errorMessage": "La solicitud TIENDA-2025-06-11-10-16-57-e3060a3b-29b89d79-c880b647-c4bf4dfe fue exitosa"
        }
      ]
    },
    "property": []
  },
  "responseBody": [
    {
      "coverage": false,
      "departament": "ANTIOQUIA",
      "departamentDANE": "05"
    },
    {
      "coverage": false,
      "departament": "SAN ANDRES",
      "departamentDANE": "88"
    },
    {
      "coverage": false,
      "departament": "AMAZONAS",
      "departamentDANE": "91"
    }
  ]
}

Respuesta de error (4xx/5xx)

{
  "status": 409,
  "code": "INVALID_FIELD",
  "message": {
    "message": ""
  },
  "messageServer": "No such column 'Segmento' on entity 'Account'.",
  "cause": [
    {
      "origin": "bot-xapi-services",
      "message": "org.mule.extension.http.api.request.validator.ResponseValidatorTypedException"
    }
  ]
}

{
  "status": 500,
  "code": "INTERNAL_SERVER_ERROR",
  "message": {
    "message": "HTTP GET on resource 'http://0.0.0.0:8080/XXXXX/services/xxxxxx' failed: internal server error (500)."
  },
  "messageServer": "Descripcion del error. Detalle de porque fallo.",
  "cause": [
    {
      "origin": "bot-xapi-services",
      "message": "org.mule.extension.http.api.request.validator.ResponseValidatorTypedException"
    }
  ]
}

---

Esquemas de datos

Respuesta exitosa (200)

Campo	Tipo	Obligatorio	Descripción
responseHeader.system.name	String	Sí	Nombre del sistema que responde.
responseHeader.system.correlationID	Number	Sí	ID de correlación para trazabilidad.
responseHeader.system.processingServer	String	No	Servidor de procesamiento.
responseHeader.service.status	String	Sí	Estado de la respuesta.
responseHeader.service.responseDate	String	Sí	Fecha y hora de la respuesta.
responseHeader.service.statusDetail.errorCode	String	Sí	Código del resultado.
responseHeader.service.statusDetail.errorDetailCode	String	Sí	Detalle del código.
responseHeader.service.statusDetail.errorMessage	String	No	Mensaje descriptivo.
responseHeader.property	Object	No	Propiedades adicionales.
responseBody.coverage	String	Sí	Estado de cobertura.
responseBody.departament	String	Sí	Nombre del departamento.
responseBody.departamentDANE	String	Sí	Código DANE del departamento.

Respuesta de error (4xx/5xx)

Campo	Tipo	Obligatorio	Descripción
code	String	Sí	Código HTTP asociado al error.
status	Number	Sí	Código estandarizado del error.
message.message	String	No	Mensaje comprensible para humanos.
messageServer	String	Sí	Descripción técnica del error.
cause.origin	String	Sí	Nombre de la API o capa generadora del error.
cause.message	String	Sí	Descripción técnica del error.

---

Diagramas

Diagrama de flujo

Espacio reservado para el diagrama de flujo.

Diagrama de secuencia

Espacio reservado para el diagrama de secuencia.

---

Políticas de seguridad

Autenticación

• OAuth 2.0 Access Token Enforcement Using External Provider.
• Validación del token, su vigencia y scope asociado al client_id.
• Respuesta de “Acceso denegado” si el token es inválido o no autorizado.

SLAs

• Puede incluir límite de 1000 req/min por cliente.
• Tiempos de respuesta sujetos a acuerdos establecidos.

Rate Limits

• Anypoint Security:

  • Longitud máxima de ruta: 4096 bytes.
  • Longitud máxima de encabezado: 16384 bytes.

• CloudHub 2.0:

  • Tamaño máximo de URI: 4 KB.
  • Longitud máxima del encabezado HTTP: 32 KB.

---

Errores comunes

• 409 INVALID_FIELD: Campo inválido en la solicitud.
• 500 INTERNAL_SERVER_ERROR: Error interno al procesar la solicitud.

---

Dependencias

• Recepción de peticiones desde sistemas externos.

• Envío a la capa de sistema:

  https://bot-sapi-services-dev.us-e2.cloudhub.io/bot/parameters/departments/v1

• Comunicación con BotService:

  http://botdev.portallteqa.p.azurewebsites.net/api/parameters/v1/getdepartments

---

Historial de cambios

Versión	Fecha	Descripción
En desarrollo	16/06/2025	Creación inicial con operación departments