목차

목표

요구 사항

서론

설정

컨트롤러에서 앱 생성

Open API 인증 완료

새 사이트 생성

확인

목표

이 가이드는 Open API를 통해 Omada 컨트롤러에서 사이트를 생성하는 방법을 안내합니다.

요구 사항

• Omada 컨트롤러(하드웨어 컨트롤러/소프트웨어 컨트롤러/Omada 클라우드 기반 컨트롤러)
• Postman

서론

Omada API를 활용하면 프로그래밍 방식으로 TP-Link Omada SDN 컨트롤러에 액세스할 수 있으며, 외부 시스템과의 통합 및 네트워크 관리 작업의 자동화를 가능하게 합니다. 사용자는 Omada 웹 인터페이스를 사용하지 않고도 인증, 네트워크 상태 조회, 장치 관리, 클라이언트 액세스 제어, 설정 구성을 수행할 수 있습니다. 이를 통해 자동화된 워크플로를 구축하고 Omada를 타사 플랫폼이나 모니터링 도구와 통합하기가 더 쉬워집니다.

이 가이드는 컨트롤러의 Open API를 사용하여 Omada 컨트롤러에 사이트를 생성하는 방법을 설명합니다.

설정

컨트롤러에서 앱 생성

참고: Omada Open API는 인증 코드(Authorization Code) 모드와 클라이언트 자격 증명(Client Credentials) 모드, 두 가지 모드를 지원합니다. 사용자는 필요에 따라 애플리케이션 유형을 생성할 수 있습니다. 인증 코드 모드: 타사 플랫폼이나 사용자가 사용자 신원 확인(예: TP-Link ID)을 통해 Omada 컨트롤러에 로그인해야 할 때 적합합니다. 클라이언트 모드: 사용자 상호 작용이 필요 없는 시스템 간 통합에 적합합니다. 이 가이드는 클라이언트 자격 증명 모드를 예시로 사용합니다.

1단계. 컨트롤러 웹 페이지에 로그인하고 글로벌 뷰로 전환한 후, 설정 > 플랫폼 통합 > 오픈 API > 새 앱 추가로 이동합니다.

2단계. 생성할 앱의 이름을 지정하고, 역할 및 사이트 권한을 선택합니다.

3단계. 오른쪽 상단의 '온라인 API 문서'를 클릭합니다. 온라인 문서 페이지로 리디렉션되면 인증 절차와 자세한 API 사양을 확인할 수 있습니다.

참고: 클라우드를 통해 온프레미스 컨트롤러에 액세스하는 경우, '온라인 API 문서' 옵션은 표시되지 않습니다.

Open API 인증 완료

참고: 모든 API 호출에는 액세스 토큰이 필요합니다. 이 토큰은 요청이 승인되었음을 증명하는 자격증명 역할을 합니다. 유효한 토큰이 없으면 컨트롤러가 요청을 거부합니다.

1단계. 눈 모양 아이콘을 클릭하여 클라이언트 시크릿(비밀 키)을 표시합니다. 애플리케이션을 생성한 후 클라이언트 ID와 클라이언트 시크릿을 기록해 둡니다. 이 값들은 액세스 토큰을 요청할 때 필요합니다.

2단계. 보기 아이콘을 클릭하여 Omada ID와 인터페이스 액세스 주소를 확인합니다. API 호출 시 필요하므로 이 값들을 기록해 둡니다.

3단계. 온라인 문서의 홈 페이지에 있는 2.3절을 참조하여 클라이언트 모드에서 인증을 완료하십시오. 대신 인증 코드 모드를 선택하는 경우 2.2절을 참조하십시오.

문서를 참조하여 메서드, 경로, 쿼리 매개변수 및 헤더를 등록하십시오. 본문을 원시 JSON으로 설정하고 문서에 명시된 대로 필드를 정확히 입력하십시오.

요청 URL과 매개변수를 입력하십시오.

API에서 요구하는 헤더를 추가하십시오.

.

API 문서의 매개변수에 따라 본문 부분을 완성하십시오. '보내기'를 클릭하여 요청을 전송하면 액세스 토큰이 성공적으로 반환됩니다.

참고: 액세스 토큰을 획득한 후에는 이를 사용하여 API 인터페이스에 액세스하게 됩니다.

새 사이트 생성

1단계. 이전 단계에서 획득한 액세스 토큰을 '인증' 필드에 입력합니다.

참고: 인증 헤더의 접두사는 AccessToken=이어야 합니다.

2단계. API 문서에서 호출하려는 API를 찾습니다.

3단계. 문서의 내용에 따라 해당 URL과 매개변수를 입력합니다. true로 표시된 매개변수는 필수 항목이며, false로 표시된 매개변수는 선택 사항입니다. 설정이 완료되면 'Send'를 클릭하여 요청을 전송합니다. 생성이 성공하면 errorCode 0과 siteID가 반환됩니다.

확인

'글로벌 > 대시보드'로 이동합니다. 새로 생성된 사이트가 사이트 목록에 표시되면 사이트 생성이 성공한 것입니다.

이 문서에는 기계 번역이 적용되었으며, 정확한 내용을 확인하려면 원본 영문 문서를 참고하시기 바랍니다.