ALGO RESTful API 사용자 가이드

Algo RESTful API를 사용하면 사용자는 HTTP/HTTPS 요청을 통해 네트워크의 Algo IP 엔드포인트에 대한 작업에 액세스하고, 조작하고, 트리거할 수 있습니다. 이 문서는 Algo 장치와 상호 작용하는 데 사용할 수 있는 균일하고 사전 정의된 무상태 작업 세트를 제공합니다. API는 JSON 페이로드를 사용하여 HTTP/HTTPS GET, POST 및 PUT 요청을 지원합니다.

입증

Algo RESTful API에는 세 가지 유형의 인증이 가능합니다.

표준 인증(기본적으로 활성화됨)
기본 인증(선택사항)

인증 방법 없음(권장하지 않음, 테스트 목적으로만 사용)

제품 사용 지침: RESTful API

필수 조건

RESTful API를 활성화하기 전에 사전 구성된 NTP 서버에 연결할 수 있는 인터넷 연결이 장치에 있는지 확인하십시오. 인터넷 연결을 사용할 수 없는 경우 로컬 NTP 서버를 구성하고 해당 IP 주소를 입력하세요.

RESTful API 활성화

장치의 로그인 web 인터페이스를 열고 고급 설정 관리 탭으로 이동합니다.
API 지원 섹션까지 아래로 스크롤하여 RESTful API를 활성화합니다.

원하는 비밀번호를 설정하세요(기본 비밀번호: algo). 표준 인증은 기본적으로 활성화되어 있습니다.

기본 인증 활성화(선택 사항)

에서 web 인터페이스에서 시스템 유지 관리 탭으로 이동하여 구성을 다운로드합니다. file.

구성 열기 file 텍스트 편집기를 사용하여 다음 줄을 추가합니다: api.auth.basic = 1
수정된 구성 저장 및 업로드 file 구성 복원을 사용하여 장치로 다시 File 시스템 유지 관리 탭의 기능입니다.

인증 방법 없음 활성화(선택 사항)

인증 없음 방법을 활성화하려면 RESTful API 암호 필드를 비워 둡니다. 이 방법은 권장되지 않으며 보안을 제공하지 않으므로 테스트 목적으로만 사용해야 합니다.

단순 제어 인터페이스 활성화(선택 사항)

에 web 인터페이스에서 시스템 유지 관리 탭으로 이동하여 구성을 다운로드합니다. file.

구성 열기 file 텍스트 편집기를 사용하여 두 줄을 추가합니다. 원하는 비밀번호로 변경하세요.
관리자.web.sci = 1

Sci.admin.pwd =
수정된 구성 저장 및 업로드 file 구성 복원을 사용하여 장치로 다시 File 시스템 유지 관리 탭의 기능입니다.

인증 Samp르 코드

이메일로 보내주세요 support@algosolutions.com 표준 또는 기본 인증을 원하는 경우amp코드.
추가 지원을 받으려면 전화하세요. 604-454-3792 또는 이메일 support@algosolutions.com

정보 공지

메모
참고에는 따라야 할 유용한 업데이트, 정보 및 지침이 나와 있습니다.

부인 성명

이 문서에 포함된 정보는 모든 면에서 정확하다고 여겨지지만 알고는 이를 보증하지 않습니다. 해당 정보는 사전 통지 없이 변경될 수 있으며 어떤 방식으로든 알고나 그 계열사 또는 자회사의 약속으로 해석되어서는 안 됩니다. 알고와 그 계열사 및 자회사는 이 문서의 오류나 누락에 대해 책임을 지지 않습니다. 이러한 변경 사항을 반영하기 위해 이 문서의 개정판이나 새 버전이 발행될 수 있습니다. Algo는 본 설명서나 해당 제품, 소프트웨어, 펌웨어 및/또는 하드웨어의 사용으로 인해 발생하는 손해나 청구에 대해 책임을 지지 않습니다. 이 문서의 어떤 부분도 알고의 서면 승인 없이는 어떤 목적으로든 전자적이든 기계적이든 어떤 형태나 수단으로든 복제하거나 전송할 수 없습니다.
북미 지역에 대한 추가 정보나 기술 지원이 필요한 경우 알고 지원팀에 문의하세요.

알고 기술 지원
1-604-454-3792
support@algosolutions.com

일반적인

소개

이 문서에서는 Algo RESTful API를 사용하여 HTTP/HTTPS 요청을 통해 네트워크의 Algo IP 엔드포인트에 대한 작업을 액세스, 조작 및 트리거하는 방법과 다양한 보안 수준을 갖춘 몇 가지 인증 방법을 설명합니다. 요청 시스템은 이 문서에 정의된 균일하고 사전 정의된 무상태 작업 세트를 통해 Algo 장치와 상호 작용할 수 있습니다. JSON 페이로드를 사용하여 리소스의 URI에 대한 요청이 이루어지고 JSON 응답이 도출됩니다. HTTP/HTTPS GET, POST 및 PUT 요청은 JSON 페이로드와 함께 리소스 URI에 대해 수행됩니다(페이로드 목록은 명령 섹션 참조).

입증

세 가지 유형의 인증이 있습니다.

표준(권장)

기초적인
없음(권장하지 않음)

표준 인증은 SHA-256으로 인코딩된 다이제스트와 함께 HMAC(해시 기반 메시지 인증 코드)를 사용합니다. 기본 인증은 Base64 인코딩을 사용하며 HTTPS를 통해서만 사용해야 합니다. 인증은 인증을 제공하지 않으므로 각별히 주의해서 사용해야 합니다. 자세한 내용은 인증 요구 사항 섹션을 참조하세요.

설정 및 구성

필수 조건

이 문서에서는 Algo 엔드포인트가 펌웨어 버전 3.3 이상을 실행하고 있다고 가정합니다.

표준 인증을 사용하려면 요청자와 알고 장치 간의 시간 차이가 30초 미만이어야 합니다.
NTP(네트워크 시간 프로토콜)가 사용 중인지 확인하세요. 사용자 정의 NTP 서버의 주소는 고급 설정 → 시간 탭에서 구성할 수 있습니다.

메모
사전 구성된 NTP 서버는 공개적으로 호스팅되므로 해당 서버에 연결하려면 인터넷 연결이 필요합니다. 인터넷 연결을 사용할 수 없는 경우 로컬 NTP 서버를 구성하고 해당 IP 주소를 입력하세요.

Algo 장치 시스템 시간이 올바른 시간대로 조정되어 있는지 확인하세요. 고급 설정 → 시간 탭으로 이동하면 됩니다.

RESTful API 활성화

로그인하세요 web 인터페이스를 열고 고급 설정 → 관리 탭으로 이동합니다.
API 지원 섹션까지 아래로 스크롤하여 RESTful API를 활성화하고 원하는 대로 비밀번호를 설정합니다(기본 비밀번호: algo).
메모
표준 인증은 기본적으로 활성화되어 있습니다.

기본 인증 활성화(선택 사항)

에서 web 인터페이스에서 시스템 → 유지 관리 탭으로 이동하여 구성을 다운로드합니다. file.
구성 열기 file 텍스트 편집기를 사용하여 다음 줄을 추가합니다: api.auth.basic = 1
수정된 구성 저장 및 업로드 file 구성 복원을 사용하여 장치로 다시 File 시스템 → 유지 관리 탭의 기능입니다.

인증 방법 없음(선택 사항)

단순 제어 인터페이스 활성화(선택 사항)

에 web 인터페이스에서 시스템 → 유지 관리 탭으로 이동하여 구성을 다운로드합니다. file.
구성 열기 file 텍스트 편집기를 사용하여 두 줄을 추가합니다. 변경 원하는 비밀번호로. 관리자.web.sci = 1
Sci.admin.pwd =
수정된 구성 저장 및 업로드 file 구성 복원을 사용하여 장치로 다시 File 시스템 → 유지 관리 탭의 기능입니다.

인증 요구 사항

이메일로 보내주세요 support@algosolutions.com 표준 또는 기본 인증을 원하는 경우amp코드.

JSON 페이로드를 사용한 표준 인증 요청

HTTP/HTTPS 요청의 필수 헤더
> 콘텐츠 유형: “application/json”
> 컨텐츠-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

인증: hmac admin:[nonce]:[hmac_output]
인증 헤더는 다음으로 구성됩니다.

문자열 'hmac admin' 뒤에 콜론 ':'이 옵니다.

Nonce – 무작위 또는 반복되지 않는 값이며 그 뒤에 콜론 ':'이 옵니다.
Hmac_output – 아래와 같이 장치에 구성된 RESTful API 비밀번호(비밀 키)와 HMAC 입력에 의해 생성됩니다.
[request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[목하]

HMAC 입력 예ample: ('algo'를 비밀 키로 사용)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 SHA-256을 사용하여 비밀번호 및 HMAC 입력 문자열이 포함된 HMAC를 다이제스트로 생성합니다.
예 HMAC 출력ample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

날짜: 일, 날짜, 월, 연도 시:분:초 GMT
Example
날짜: 22년 2022월 02일 목요일 33:07:XNUMX GMT
페이로드 ex를 사용한 표준 인증amp르 :

JSON 페이로드가 없는 표준 인증 요청

콘텐츠 관련 헤더/hmac 입력이 생략된 3.1과 동일합니다.
HMAC 입력: [request_method]:[request_uri]:[timestamp]:[nonce] HMAC 입력 예ample: ('algo'를 비밀 키로 사용)
GET:/api/settings/audio.page.vol:1601312252:49936
SHA-256을 사용하여 비밀번호와 HMAC 입력 문자열로 HMAC를 생성합니다.
예 HMAC 출력ample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
페이로드가 없는 표준 인증 examp르 :

기본 인증 요청

이 인증 방법은 표준 방법보다 덜 안전하므로 주의해서 사용해야 합니다.

인증: 기본 [base64]
Examp르 :
인증: 기본 YWRtaW46YWxnbwo=
기본 인증 예amp르 :

명령

RESTful API 명령

다음은 지원되는 모든 API 명령 목록입니다.

메모
PUT 요청은 재부팅 후에도 유지되는 영구 리소스를 변경하거나 생성하는 반면, POST 요청은 현재 세션에 대한 장치만 제어합니다.

설명	방법	우리말	유효 탑재량 매개변수	반품 Example	제품	FW
특정 매개변수의 값을 검색합니다.	얻다	/api/settings/[키 이름] Ex./api/settings/audio.page.vol	없음	{“audio.page.vol”: “-18dB”}	모두	> 3.3
데시벨 단위로 측정된 주변 소음 수준을 반환합니다. 기본 설정 -> 기능 탭에서 주변 소음 보상을 활성화해야 합니다.	얻다	/api/info/audio.noise.level	없음	{"오디오.노이즈.레벨": 72}	스피커 디스플레이 스피커	> 3.3
릴레이 입력 단자의 상태를 추출합니다.	얻다	/api/info/input.relay.status	없음	{“input.relay.status”: “idle”} 또는 {“input.relay.status”: “active”}	8063을 제외한 릴레이 입력이 있는 모든 제품. 아래를 참조하세요.	> 4.1
입력 1 또는 입력 2 단자의 상태를 추출합니다.	얻다	/api/info/input.relay1.status 또는 /api/info/input.relay2.status	없음	{“input.relay1.status”: “유휴”} 또는 {“input.relay1.status”: “활성”}	8063	> 4.1
톤 목록 검색 file현재 설치되어 있습니다.	얻다	/api/info/tonelist	없음	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	모두	> 5.0
상태 페이지에 표시되는 장치 정보를 검색합니다.	얻다	/api/정보/상태	없음	상태 탭의 전체 정보 목록입니다.	모두	> 5.4

정보 페이지에 표시되는 제품 정보를 검색합니다.	얻다	/api/정보/정보	없음	정보 탭에 있는 모든 정보.	모두	> 5.4
원하는 색상 및 패턴 매개변수로 스트로브를 활성화합니다.	우편	/api/controls/스트로브/시작	패턴: {0 – 15} color1: {파란색, 빨간색, 호박색, 녹색} color2: {파란색, 빨간색, 호박색, 녹색} ledlvl: {1 – 255} 홀드오버: {참, 거짓}	없음	8128(G2) 8138 8190S	> 3.3
스트로보를 중지합니다.	우편	/api/controls/strobe/중지	없음	없음	8128(G2) 8138 8190S	> 3.3
톤을 한 번 재생하거나 반복합니다.	우편	/api/controls/톤/시작	경로: {tone} 즉. 차임.wav 루프: {참, 거짓} 또는 {0, 1} 예: {"path":"chime.wav", "loop":true}	없음	스피커 8301 8373 8028(G2) 8201 8039	> 3.3
톤을 중지합니다.	우편	/api/controls/tone/중지	없음	없음	스피커 8301 8373 8028(G2) 8201 8039	> 3.3
미리 녹음된 메시지로 내선 번호에 전화를 겁니다.	우편	/api/controls/호출/시작	{“확장자”:”2099″, "톤":"gong.wav", "간격":"0″, "maxdur":"10″}	없음	스피커 8301 8410 8420	> 3.3
통화를 종료합니다.	우편	/api/controls/호출/정지	없음	없음	스피커 8301 8410 8420	> 3.3

단방향 페이지 호출을 시작합니다. 장치는 대상 확장에서 오디오 스트림을 수신합니다.	우편	/api/controls/call/페이지	{"확대":" ”}	없음	스피커 8410 8420	> 5.3.4
대상 엔드포인트를 재부팅합니다.	우편	/api/controls/재부팅	없음	없음	모두	> 3.3
문을 여십시오. "local"은 로컬 릴레이를 제어합니다. "netdc1"은 원격 네트워크 도어 컨트롤러(8063)를 제어합니다.	우편	/api/controls/문/잠금 해제	doorid: {로컬, netdc1} *선택 과목	없음	8039 8028(G2) 8201 8063	> 3.3
문을 잠급니다.	우편	/api/controls/도어/잠금	doorid: {로컬, netdc1} *선택 과목	없음	8039 8028(G2) 8201 8063	> 3.3
24v 보조 출력 릴레이를 활성화합니다.	우편	API/컨트롤/24v/활성화	없음	없음	8063	> 5.0
24v 보조 출력 릴레이를 비활성화합니다.	우편	API/컨트롤/24v/비활성화	없음	없음	8063	> 5.0
출력 릴레이를 활성화합니다.	우편	/api/controls/relay/활성화	없음	없음	8063	> 5.0
출력 릴레이를 비활성화합니다.	우편	/api/controls/릴레이/비활성화	없음	없음	8063	> 5.0
알고의 펌웨어 서버에서 최신 펌웨어 버전을 확인하십시오.	우편	/api/controls/업그레이드/확인	없음	{“버전”: “업데이트”} 또는 {"버전": " ”}	모두	> 4.1
알고의 펌웨어 서버에서 최신 펌웨어 버전을 확인하고 해당 버전으로 업그레이드하세요.	우편	/api/controls/업그레이드/시작	없음	{“상태”: “업데이트됨”} 또는 {“상태”: “업그레이드 중 ","url”: url>} 또는 {"상태": " ”}	모두	> 4.1
화면에 이미지나 패턴을 표시합니다.	우편	/api/controls/화면/시작	보다 아래에	없음	8410 8420	> 5.3.4
화면 패턴을 멈추고 기본 화면으로 돌아갑니다.	우편	/api/controls/화면/중지	없음	없음	8410 8420	> 5.3.4

기본 응용 프로그램을 다시 시작하십시오.	우편	/api/controls/reload	없음	없음	모두	> 5.3.4
직접 오디오 스트림 듣기를 시작하세요. 스트림이 전송되는 포트 번호를 구성합니다.	우편	/api/controls/rx/start	{"포트": }	없음	모두	> 5.3.4
직접 오디오 스트림 듣기를 중지합니다.	우편	/api/controls/rx/stop	없음	없음	모두	> 5.3.4
멀티캐스트 모드를 설정합니다.	놓다	/api/state/mcast/업데이트/	{"모드":"발신자", "주소": , "포트": , “유형”:”rtp”} 또는 {“모드”:”발신자”, “주소”: , "포트": , “유형”:”폴리”, “그룹”:1} 참고: 이 명령 전에 controls/tone/start가 사용되면 톤은 장치의 현재 설정을 사용하여 재생됩니다. web UI.	없음	8301	> 5.0
JSON 페이로드의 특정 매개변수에 값을 삽입합니다.	놓다	/api/설정	매개변수: {값} 예: {“audio.page.vol”: “-3dB”}	없음	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

SCI(간단한 제어 인터페이스) 명령

모든 SCI 명령은 GET 요청이며 인증을 위한 공통 매개변수 "usi" 및 "admin"이 있습니다.
Examp르 :
http를 얻으세요:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

설명	우리말	추가의 유효 탑재량 매개변수	제품	FW
문을 여십시오. "local"은 로컬 릴레이를 제어합니다. "netdc1"은 원격 네트워크 도어 컨트롤러(8063)를 제어합니다.	/sci/controls/do 또는/unlock	doorid: {로컬, netdc1} *선택 과목	8039 8028(G2) 8201 8063	> 3.3
문을 잠급니다.	/sci/controls/do 또는/lock	doorid: {로컬, netdc1} *선택 과목	8039 8028(G2) 8201 8063	> 3.3
톤을 한 번 재생하거나 반복합니다.	/sci/controls/ne/start로	경로: {tone} 즉. 차임.wav 루프: {참, 거짓} 또는 {0, 1}	모두	> 3.3
톤을 중지합니다.	/sci/controls/ne/stop으로	없음	모두	> 3.3
원하는 색상 및 패턴 매개변수로 스트로브를 활성화합니다.	/sci/controls/스트로브/시작	패턴: {0 – 15} 색상1: {파란색, 빨간색, 호박색, 녹색} color2: {파란색, 빨간색, 호박색, 녹색} ledlvl: {1 – 255} 홀드오버: {true, false}	8128(G2) 8138 8190S	> 3.3
스트로보를 중지합니다.	/sci/controls/스트로브/중지	없음	8128(G2) 8138 8190S	> 3.3

문서 / 리소스

	ALGO RESTful API [PDF 파일] 사용자 가이드 AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [PDF 파일] 사용자 가이드 AL061-GU-CP000API-230717, RESTful API, RESTful, API

참고문헌

사용자 설명서

ALGO RESTful API

상품정보: RESTful API 가이드

입증

제품 사용 지침: RESTful API

필수 조건

RESTful API 활성화

기본 인증 활성화(선택 사항)

인증 방법 없음 활성화(선택 사항)

단순 제어 인터페이스 활성화(선택 사항)

인증 Samp르 코드

정보 공지

부인 성명

일반적인

소개

입증

설정 및 구성

필수 조건

RESTful API 활성화

기본 인증 활성화(선택 사항)

인증 방법 없음(선택 사항)

단순 제어 인터페이스 활성화(선택 사항)

인증 요구 사항

JSON 페이로드를 사용한 표준 인증 요청

JSON 페이로드가 없는 표준 인증 요청

기본 인증 요청

명령

RESTful API 명령

SCI(간단한 제어 인터페이스) 명령

문서 / 리소스

참고문헌

댓글을 남겨주세요

답변 취소