자동 등록 API 사용

Auto registration API를 사용하여 자동으로 기기를 Control Room으로 등록하고 연결합니다.

이 API는 autoregistration.properties 파일의 일반 등록 토큰을 사용하여 지정된 Control Room URL에 기기를 등록합니다. Control Room URL을 autoregistration.properties 파일에서 사용할 수 없으면 기기를 자동으로 등록할 수 없습니다. autoregistration.properties 파일은 로컬 시스템에서 사용할 수 있어야 하며 등록이 완료된 후 파일을 삭제하면 안 됩니다.

주: 명령줄 또는 API를 통해 기기를 등록하려면 AA_DELAY_REGISTRATION_UNTIL_LOGIN MSI 매개변수를 설정해야 합니다. Bot 에이전트 MSI 파일이나 autoregistration.properties 파일에서 이 매개변수를 활성화할 수 있습니다. 자세한 내용은 기기에 Bot 에이전트 대량 설치 항목을 참조하십시오. 대량 설치 항목에서 샘플 autoregistration.properties 파일을 볼 수도 있습니다.

요청

POST http://127.0.0.1:22113/v1/registration/auto
요청 본문:
{ "url": "https://{controlroom url}", "userName": "dpcreator" }

요청 매개변수

매개변수 유형 필수 설명
url 문자열

기기를 자동 등록할 Control Room URL을 지정합니다.

사용자 이름 문자열 아니오

기본 기기로 연결할 기기의 Control Room 사용자를 지정합니다.

응답

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

응답 매개변수

매개변수 유형 설명
결과 문자열 기기 등록 상태입니다.
deviceId 숫자 Bot 에이전트가 설치된 기기의 고유 ID입니다.
crUrl 문자열

기기가 자동으로 등록되는 Control Room URL입니다.

사용자 이름 문자열

기본 기기로 연결된 기기의 사용자 이름입니다.

설치 유형 문자열 수행되는 설치 유형입니다.
crSwitchAllowed 문자열 다른 Control Room에 기기를 등록할 수 있는지 여부를 나타냅니다.
REST API는 HTTP 응답 코드를 이용하여 각 요청에 응답합니다. 응답 코드는 API 응답 코드의 내용을 참조하십시오.