Como usar a API de registro automático

Registre e conecte seu dispositivo automaticamente a uma Control Room usando a API Auto registration.

Esta API usa o token de registro genérico Control Room do arquivo autoregistration.properties para registrar o dispositivo na URL especificada da Control Room. Você não pode registrar automaticamente o dispositivo, se a URL da Control Room não estiver especificada no arquivo autoregistration.properties . O arquivo autoregistration.properties deve estar disponível no sistema local e você não deve excluir o arquivo após a conclusão do registro.

Nota: Para registrar o dispositivo a partir da linha de comando ou API, você deve definir o parâmetro MSI AA_DELAY_REGISTRATION_UNTIL_LOGIN. Você pode ativar esse parâmetro no arquivo Bot Agent MSI ou no arquivo autoregistration.properties. Para obter mais informações, consulte Instalação em massa do Agente de bot. Você também pode visualizar um exemplo de arquivo autoregistration.properties no tópico de instalação em massa.

Solicitação

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

Parâmetros da solicitação

Parâmetro Tipo Obrigatório Descrição
url String Sim

Especificar a URL da Control Room para registrar automaticamente o dispositivo.
userName String Não

Especifique o usuário da Control Room para associar o dispositivo como o dispositivo padrão.

Resposta

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

Parâmetros de resposta

Parâmetro Tipo Descrição
result String Status do registro do dispositivo.
deviceId Número ID exclusivo do dispositivo em que o Agente de bot está instalado.
crUrl String

A URL da Control Room onde o dispositivo está autoregistrado.
userName String

O nome de usuário ao qual o dispositivo está associado como dispositivo padrão.
installationType String O tipo de instalação que é executada.
crSwitchAllowed String Indica se o dispositivo pode ser registado em uma Control Room diferente.
A API REST responde a cada solicitação com um código de resposta HTTP. Para códigos de resposta, consulte Códigos de resposta da API.