Skip to main content

Servicio de Desenrollamiento

Este servicio consta de dos partes: autenticación y desenrollamiento. La autenticación genera un token de autorización necesario para consumir el servicio de desenrollamiento, que permite eliminar la asociación de un cliente a un proyecto específico.

1. Autenticación

Para acceder al servicio de desenrollamiento, primero es necesario autenticarse y obtener un token de autorización (Bearer token). Este proceso de autenticación se realiza mediante la siguiente ruta:

Endpoint de Autenticación:

curl --location 'https://apigw-dev.ado-tech.com/api/token/{realme}' \
--data-urlencode 'client_id=user' \
--data-urlencode 'client_secret=crenetials' \
--data-urlencode 'grant_type=client_credentials'

Parámetros de Autenticación

  • client_id: Identificador único del cliente. En este ejemplo, es user.
  • client_secret: Credenciales secretas específicas del cliente, necesarias para la autenticación.
  • grant_type: Tipo de permiso requerido para obtener el token. En este caso, es client_credentials.

Respuestas de Autenticación

Si la autenticación es exitosa, el servicio responderá con un token de autorización en formato Bearer. Este token es necesario para realizar la solicitud de desenrollamiento en el siguiente paso.

{
    "access_token": "eyJhbGciOiJSUzI1NiIsI...",
    "token_type": "Bearer",
    "expires_in": 300
}
  • access_token: El token generado por el servicio.
  • token_type: El tipo de token generado por el servicio. En estos caso será de tipo Bearer.
  • expires_in: El tiempo de vida del token generado en milisegundos.

En caso de error, el servicio de autenticación puede devolver uno de los siguientes códigos de respuesta, junto con mensajes de error relevantes:

  • 400 Bad Request: Credenciales incorrectas o incompletas. 
     
    {
    "error": "Credenciales inválidas."
}

2. Desenrollamiento de Cliente

Una vez obtenido el token de autenticación, puede utilizarse para consumir el servicio de desenrollamiento del cliente. Este servicio elimina la asociación de un cliente con el proyecto especificado.

Endpoint de Desenrollamiento de Cliente:

curl --location 'https://apigw-dev.ado-tech.com/api/identity-manager/unroll-client' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
    "projectName": "ProjectName",
    "documentType": 1,
    "documentNumber": "123456789"
}'

Parámetros del Cuerpo de la Solicitud

  • projectName: Nombre del proyecto del que se desea desenrollar al cliente. Ejemplo: "ProjectName1".
  • documentType: Tipo de documento de identificación del cliente. Este valor es un número entero que representa el tipo de documento.
  • documentNumber: Número de documento de identificación del cliente.

Nota: El valor {token} en el encabezado Authorization debe ser reemplazado con el token de autorización obtenido en el paso de autenticación.

Respuestas del Servicio de Desenrollamiento

El servicio de desenrollamiento devolverá una respuesta indicando el éxito o el fallo del desenrollamiento solicitado. Las posibles respuestas incluyen:

200 OK: Desenrollamiento exitoso; el cliente ha sido desenrollado del proyecto.

400 Bad Request: No se ha encontrado el usuario con el documento y el tipo de documento especificados

{ "error": "Can't found User with specified credentials"}

401 Unauthorized: Token de autorización no proporcionado.

{ "error": "Token inválido." }
{"error": "Token no proporcionado."}

401 Unauthorized: Token de autorización inválido, expirado.

{ "error": "Token inválido." }

404 Not Found: No se encuentra el proyecto, debe a que este mal escrito o no este habilitado para esta función.

{ "error": "The specified project was not found" }

Este servicio está diseñado para facilitar la eliminación segura de la relación de un cliente con un proyecto específico, utilizando autenticación basada en tokens para garantizar la seguridad y la integridad de las solicitudes.

Back to top