Requisitos previos al usar API

Primeros pasos

ManageEngine Endpoint Central ahora brinda una fácil integración con su infraestructura existente utilizando las API REST. Puede realizar varias actividades de gestión de desktops fácilmente desde una única consola. Puede encontrar la lista de módulos para los que hay API disponibles en la barra lateral, si necesita más API puede ponerse en contacto con nosotros con su requerimiento.

Este documento describe los requisitos previos para utilizar la API.

API - Estructura de URL

Todas las URL de API deben estar estructuradas en el siguiente formato,

Respuesta en paginación

Algunos endpoints de la API devuelven respuestas que consisten en conjuntos de objetos. Se trata de respuestas en paginación que devuelven solo un subconjunto o una página de todos los objetos de esa API.

El límite de páginas y los parámetros de página se utilizan para especificar el número de objetos por respuesta y qué página debe recuperarse.

For example, if you want the API to return 10 objects per page and wish to see the second page, add the following line at the end of the API

Buscar

La operación de búsqueda puede realizarse en endpoints de la API que devuelven respuestas en paginación.

Los parámetros de tipo de búsqueda y columna de búsqueda se establecen en el nombre de la columna en la que hay que buscar y el valor de búsqueda se establece en la consulta de búsqueda.

Por ejemplo, para buscar software que contenga "Adobe" en el inventario de software, añada la siguiente línea al final de la API

Autenticación

El token de autenticación es necesario para acceder a nuestra API. Para obtener el token de autenticación siga estos pasos.

Endpoint de la API de autenticación

1(a). Generar token mediante autenticación local

Envíe una solicitud POST con la cabecera HTTP Content-Type:application/json y el siguiente JSON en el cuerpo de la solicitud a la API de autenticación.

POST /api/1.4/desktop/authentication

{ 
 "username":<Username>,
 "password":<Password base64 encoded>, 
 "auth_type":"local_authentication" 
}
      

1(b). Generar token a través de la autenticación de AD

Los nombres de dominio pueden obtenerse de la api de descubrimiento del servidor. Envíe una solicitud POST con la cabecera HTTP Content-Type:application/json y el siguiente JSON en el cuerpo de la solicitud a la API de autenticación.

POST /api/1.4/desktop/authentication

{ 
 "username":<Username>,
 "password":<Password base64 encoded>, 
 "auth_type":"ad_authentication" ,
 "domainName": <Domain name>
}

2. Obtener token de autenticación de la respuesta

{ "message_type": "authentication", "message_response": {"authentication": { "user_permissions": { "read": ["Common_Read","SOM_Read", "Tools_Read"], "admin": ["Common_Admin","SOM_Admin","Tools_Admin" ], "write": [ "Common_Write","SOM_Write","Tools_Write"] },"user_data": { "auth_type": "Local Authentication", "user_id": 1, "user_name": "admin", "phone_number": null, "email": "" }, "auth_data": { "auth_token": "B42550F3-006D-48EB-8011-F6C7D6323EE7"} } }, "message_version": "1.0", "status": "success" } 

3. Establecer el token de autenticación en la cabecera de la solicitud

Establezca el token de autenticación desde la cabecera HTTP de autorización para todas las solicitudes.

Generación de contraseña codificada en Base64

1. Desde la consola web de Endpoint Central, vaya a Admin -> Explorador de API.
2. En el panel izquierdo, haga clic en Autenticación -> Inicio de sesión.
3. Elija el tipo de autenticación como Autenticación local o Autenticación de AD y proporcione el nombre de usuario y la contraseña.
4. Tras la ejecución, obtendrá la contraseña codificada en base64 junto con el token de autenticación.

Autenticación de dos factores

Si la autenticación de dos factores está activada, realice los siguientes pasos para obtener el token de autenticación:

1. Al realizar una solicitud para el endpoint de la API de autenticación, en lugar de recibir la respuesta especificada anteriormente, se obtendrá la siguiente respuesta:-

   {
       "message_type": "authentication",
       "message_response": {
           "authentication": {
               "two_factor_data": {
                   "unique_userID": "admin85424",
                   "is_TwoFactor_Enabled": true,
                   "message": "Google authentication already created for this user. Validate OTP",
                   "remember_token_days": 1,
                   "OTP_Validation_Required": true
               }
           }
       },
       "message_version": "1.0",
       "status": "success"
   }
   

2. Tendrá que hacer uso del identificador único de usuario de esta respuesta y realizar la siguiente solicitud:

   POST api/1.4/desktop/authentication/otpValidate
   
   { 
    "uid":"admin85424", 
    "otp":"761666",
    "rememberme_enabled":"true"
   }   
   

3. La OTP especificada aquí se generará a través de la aplicación de Autenticación que esté utilizando o de la dirección de correo registrada, dependiendo del modo de autenticación habilitado para la autenticación de dos factores.
4. Tras la ejecución, se generará el token de autenticación.

   { "message_type": "authentication", "message_response": {"authentication": { "user_permissions": { "read": ["Common_Read","SOM_Read", "Tools_Read"], "admin": ["Common_Admin","SOM_Admin","Tools_Admin" ], "write": [ "Common_Write","SOM_Write","Tools_Write"] },"user_data": { "auth_type": "Local Authentication", "user_id": 1, "user_name": "admin", "phone_number": null, "email": "" }, "auth_data": { "auth_token": "B42550F3-006D-48EB-8011-F6C7D6323EE7"} } }, "message_version": "1.0", "status": "success" }