용어와 정의

영문 또는 원어: DSM Web API

DSM의 영문 정식명칭: DiskStation Manager

API의 영문 정식명칭: Application Programming Interface

한글명: DSM 웹 응용 프로그래밍 인터페이스

프로그램이 DSM의 제공 기능을 웹 요청으로 이용할 때 사용하는 Synology의 API 체계다.

DSM Web API 의미와 사용 예시

DSM Login Web API 문서는 사용 가능한 API 정보를 알아보는 SYNO.API.Info와 로그인 및 로그아웃을 수행하는 SYNO.API.Auth를 구분한다. 애플리케이션이 이용 가능한 기능의 이름과 버전을 확인하고 필요한 인증을 진행하는 방식이다.

사람이 화면에서 버튼을 누르는 대신 프로그램이 정해진 요청을 보내 DSM 기능을 이용하는 접점이다. 먼저 어떤 API 이름과 버전을 쓸 수 있는지 확인하고 필요한 인증을 거친다.

DSM과 지원 패키지를 연동하는 개발이나 자동화에 쓰인다. 로그인 안내서의 SYNO.API.Info 및 SYNO.API.Auth와 각 패키지의 API 문서를 함께 확인한다.

API가 있다는 사실은 모든 관리 작업이 공개 API로 제공된다는 뜻이 아니다. 요청 경로, API 버전, 인증과 계정 권한을 각각 확인해야 한다. 문서의 예제 비밀번호를 실환경에 재사용하거나 인증 정보를 공개 URL에 노출하면 안 된다.