Verwendung der API für automatische Registrierung

Registrieren Sie Ihr Gerät automatisch und verbinden Sie es mit einem Control Room mithilfe der Auto registration-API.

Diese API verwendet das generische Control Room-Registrierungs-Token aus der Datei autoregistration.properties, um das Gerät unter der angegebenen Control Room-URL zu registrieren. Sie können das Gerät nicht automatisch registrieren, wenn die Control Room-URL nicht in der Datei autoregistration.properties verfügbar ist. Die Datei autoregistration.properties muss auf Ihrem lokalen System vorhanden sein und Sie dürfen die Datei nach Abschluss der Registrierung nicht löschen.

Anmerkung: Um das Gerät über die Befehlszeile oder API zu registrieren, müssen Sie den MSI-Parameter AA_DELAY_REGISTRATION_UNTIL_LOGIN festlegen. Sie können diesen Parameter in der Datei Bot Agent MSI oder autoregistration.properties aktivieren. Weitere Informationen finden Sie unter Masseninstallation von Bot-Agenten. Außerdem finden Sie eine Beispieldatei autoregistration.properties unter dem Thema Masseninstallation.

Anforderung

POST http://127.0.0.1:22113/v1/registration/auto
Text der Anforderung:
{
    "url": "https://{controlroom url}",
    "userName": "dpcreator"
}

Anforderungsparameter

Parameter Typ Erforderlich Beschreibung
URL Zeichenfolge Ja

Geben Sie die Control Room-URL an, um die automatische Registrierung durchzuführen. -Gerät.
userName Zeichenfolge Nein

Geben Sie den Control Room-Nutzer an, um das Gerät als Standardgerät festzulegen.

Antwort

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

Antwortparameter

Parameter Typ Beschreibung
Ergebnis Zeichenfolge Status der Geräteregistrierung
deviceId Nummer Eindeutige ID des Geräts, auf dem der Bot-Agent installiert ist.
crUrl Zeichenfolge

Die Control Room-URL, unter der das Gerät automatisch registriert ist.
userName Zeichenfolge

Der Nutzername, für den das Gerät als Standard zugeordnet ist -Gerät.
installationType Zeichenfolge Die Art der Installation, die durchgeführt wird
crSwitchAllowed Zeichenfolge Gibt an, ob das Gerät in einem anderen Control Room registriert werden kann.
Die REST-API antwortet auf jede Anforderung mit einem HTTP-Antwortcode. Weitere Informationen zu Antwortcodes finden Sie unter API-Antwortcodes.