API Portabilidades v1

Descripción general

Recurso de la capa de experiencia encargado de gestionar la portabilidad del cliente. Registra la información del request y response, así como los datos clave necesarios para la auditoría y el control de los llamados realizados a la API.

Categoría de Negocio: Movilidad

---

Capa de experiencia

Endpoint y método

POST [https://bot-xapi-services-qa.us-e2.cloudhub.io/v1/salesOrder/portabilities/{operacion}](https://bot-xapi-services-qa.us-e2.cloudhub.io/v1/salesOrder/portabilities/{operacion})

Especificación (enlace si existe)

Estable

Descripción funcional

Permite gestionar solicitudes de portabilidad, validando datos de la línea y generando solicitudes en BotService, con registro para auditoría y control.

---

Capa de proceso

No aplica.

---

Capa de sistema

Endpoint y método

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

Especificación

Ver en Anypoint Exchange

Descripción funcional

Consulta directamente la API BotService para gestionar la SIM card del cliente. Usa la ruta interna:

[http://botdev.portallteqa.p.azurewebsites.net/api/saleorder/v1/portability](http://botdev.portallteqa.p.azurewebsites.net/api/saleorder/v1/portability)


---

## Ejemplos de Request/Response

### Solicitud (request)
```json
{
  "date": "2025-05-25T00:00:00",
  "nip": "",
  "numOrder": "MDM-PLTE-022944",
  "operator": "FAKE",
  "operatorCode": "00036",
  "planType": "2",
  "phone": "3000000019",
  "resend": false,
  "extendedMonth": true,
  "order": {
    "flow": "LTE"
  }
}

Respuesta exitosa (200)

{
  "responseHeader": {
    "system": {
      "name": "TIENDA",
      "correlationID": "TIENDA-220520251453-1067385177",
      "processingServer": ""
    },
    "service": {
      "status": "OK",
      "responseDate": "2025-03-09T11:12:53.8492443-05:00",
      "processingServer": "",
      "statusDetail": [
        {
          "errorCode": "OK_01",
          "errorDetailCode": "La solicitud TIENDA-220520251453-1067385177 fue exitosa",
          "errorMessage": "Se solicito de manera exitosa el NIP",
          "errorMessageUser": ""
        }
      ]
    },
    "properties": [
      {
        "name": "FLUJO",
        "value": "LTE"
      }
    ]
  }
}

Respuesta de error (4xx/5xx)

{
  "status": 409,
  "code": "INVALID_FIELD",
  "message": { "message": "" },
  "messageServer": "ERROR at Row:1:Column:212 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

Solicitud

Campo	Tipo	Obligatorio	Descripción
date	String	Sí	Fecha de la solicitud.
nip	String	Sí	NIP de validación.
numOrder	String	No	Número de orden.
operator	String	Sí	Nombre del operador.
operatorCode	String	Sí	Código del operador.
planType	String	Sí	Tipo de plan.
phone	String	Sí	Número de teléfono.
resend	Boolean	Sí	Indicador de reenvío.
extendedMonth	Boolean	Sí	Mes extendido.
order.flow	String	Sí	Flujo de la solicitud.

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.
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.properties.name	String	No	Nombre de la propiedad adicional.
responseHeader.properties.value	String	No	Valor de la propiedad adicional.

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 el 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/salesOrder/encrypted/v1

• Comunicación con BotService:

  http://botdev.portallteqa.p.azurewebsites.net/api/saleorder/v1/portability

---

Historial de cambios

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