Usar la API de registro automático

Registre y conecte automáticamente su dispositivo a una Control Room al utilizar la API de Auto registration.

Esta API utiliza el token de registro genérico de Control Room del archivo autoregistration.properties para registrar el dispositivo en la dirección URL de la Control Room especificada. No puede registrar automáticamente el dispositivo si el URL de Control Room no está disponible en el archivo autoregistration.properties. El archivoautoregistration.properties debe estar disponible en su sistema local y no se debe eliminar una vez que se haya completado el registro.

Nota: Para registrar el dispositivo a través de la línea de comandos o de la API, debe establecer el parámetro MSI AA_DELAY_REGISTRATION_UNTIL_LOGIN. Puede habilitar este parámetro en el archivo Bot Agent MSI o en el archivo autoregistration.properties. Para obtener más información, consulte Agente de bot de instalación masiva. También puede ver un archivo autoregistration.properties de muestra en el tema de instalación masiva.

Solicitud

POST http://127.0.0.1:22113/v1/registration/auto
Solicitar cuerpo:
{
    "url": "https://{controlroom url}",
    "userName": "dpcreator"
}

Parámetros de solicitud

Parámetro Tipo Obligatorio Descripción
dirección url Cadena Sí

Especifique la dirección URL de Control Room para registrar automáticamente el dispositivo.
userName Cadena No

Especifique el usuario de Control Room para asociar el dispositivo como el dispositivo predeterminado.

Respuesta

{
  "result": "REGISTERED",
  "deviceId": "11",
  "crUrl": "control_room_url",
  "userName": "dpcreator"
  "installationType": "SYSTEM_WIDE",
  "crSwitchAllowed": "false",
}

Parámetros de respuesta

Parámetro Tipo Descripción
resultado Cadena Estado del registro del dispositivo.
deviceId Número ID única del dispositivo en el que el Agente de bot está instalado.
crUrl Cadena

La dirección URL de Control Room en la que el dispositivo se registra automáticamente.
userName Cadena

El nombre de usuario al que se asocia el dispositivo como predeterminado dispositivo.
installationType Cadena Es el tipo de instalación que se lleva a cabo.
crSwitchAllowed Cadena Indica si el dispositivo se puede registrar en otra Control Room.
La API REST responde a cada solicitud con un código de respuesta HTTP. Para ver los códigos de respuesta, consulte Códigos de respuesta de API.