Utilisation de l'API d'enregistrement automatique

Inscrivez et connectez automatiquement votre périphérique à une Control Room en utilisant l'API Auto registration.

Cette API utilise le jeton d'enregistrement générique du fichier autoregistration.properties pour enregistrer le périphérique dans l'URL de la Control Room spécifiée. Vous ne pouvez pas procéder à l'inscription automatique du périphérique si l'URL de la Control Room n'est pas spécifiée dans le fichier autoregistration.properties. Le fichier autoregistration.properties doit être disponible sur votre système local et vous ne devez pas supprimer le fichier une fois l'enregistrement terminé.

Remarque : Pour inscrire le périphérique depuis la ligne de commande ou l'API, vous devez définir le paramètre MSI AA_DELAY_REGISTRATION_UNTIL_LOGIN. Vous pouvez activer ce paramètre dans le fichier Bot Agent MSI ou dans le fichier autoregistration.properties. Pour plus d'informations, consultez Installation en masse du Agent de robot sur les appareils. Vous pouvez également consulter un exemple de fichier autoregistration.properties dans la rubrique sur l'installation en masse.

Demande

POST http://127.0.0.1:22113/v1/registration/auto
Corps de la demande :
{ "url": "https://{controlroom url}", "userName": "dpcreator" }

Paramètres de la demande

Paramètre Type Obligatoire Description
url Chaîne Oui

Indiquez l'URL de la Control Room pour inscrire automatiquement le périphérique.
Nom d'utilisateur Chaîne Non

Spécifiez l'utilisateur de la Control Room pour associer le périphérique comme périphérique par défaut.

Réponse

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

Paramètres de réponse

Paramètre Type Description
result Chaîne Statut de l'enregistrement du périphérique.
deviceId Nombre ID unique du périphérique sur lequel l'Agent de robot est installé.
crUrl Chaîne

L'URL de la Control Room où le périphérique est inscrit automatiquement.
Nom d'utilisateur Chaîne

Le nom d'utilisateur pour lequel le périphérique est associé comme périphérique par défaut.
installationType Chaîne Le type d'installation qui est effectuée.
crSwitchAllowed Chaîne Indique si le périphérique peut être enregistré sur une autre Control Room.
L'API REST répond à chaque demande par un code de réponse HTTP. Pour les codes de réponse, consultez Codes de réponse de l'API.