목차

소개

사전 요구 사항

요구 사항

사용되는 구성 요소

AccessOnboard API 설명서

문서 툴에서 API 테스트

관련 정보

소개

이 문서에서는 온보드 설명서를 사용하여 vManage에 대한 REST API 호출을 검증하고 구성하는 방법에 대해 설명합니다.

사전 요구 사항

요구 사항

이 문서에 대한 특정 요건이 없습니다.

사용되는 구성 요소

이 문서는 특정 소프트웨어 버전 또는 vManage 구축 유형으로 제한되지 않습니다.

이 문서의 정보는 특정 랩 환경의 디바이스를 토대로 작성되었습니다. 이 문서에 사용된 모든 디바이스는 초기화된(기본) 컨피그레이션으로 시작되었습니다. 현재 네트워크가 작동 중인 경우 모든 명령의 잠재적인 영향을 미리 숙지하시기 바랍니다.

온보드 API 설명서 액세스

vManage 온보드 API 설명서는 URL https://<vmanage_ip>:<port:>/apidocs에 있습니다.  이 설명서는 현재 소프트웨어 버전에서 사용 가능한 API를 표시합니다.

이렇게 하려면 유효한 vManage 자격 증명으로 로그인해야 합니다.  여러 권한 수준에서 문서를 볼 수 있지만 netadmin 사용자만 모든 문서를 실행할 수 있습니다.

참고: API 설명서 페이지는 멀티테넌트 환경의 테넌트에서 사용할 수 있지만 특정 명령은 공급자로만 제한됩니다.

그런 다음 vManage는 사용 가능한 API 범주 목록을 표시합니다.  원하는 범주를 클릭한 다음 API 호출 자체를 클릭하면 다음 필드가 표시됩니다.

설명/구현 참고 사항

수행된 작업에 대한 설명입니다.

매개변수

API 호출에 대해 지정할 필수 매개 변수입니다.

요청 본문(POST/PUT/DELETE)

요청 본문의 형식입니다.

응답

vManage에서 API로 보내는 가능한 응답입니다. 여기에는 HTTP 상태 코드, 이유 및 가능한 응답 본문이 포함됩니다.

확장

통화에 유효한 내선 번호입니다.

문서 툴에서 API 테스트

사용 가능한 API는 Try It Out(It Out(테스트 실행) 옵션을 통해 테스트할 수 있습니다.

참고: 시뮬레이션은 아닙니다. 로컬 vManage에서 실제로 통화가 실행됩니다.  그에 따라 관련 영향에 대한 계획을 수립합니다.

1. Try It Out(실행 시도) 버튼을 클릭합니다.

2. 필요한 모든 매개변수를 입력합니다.

3. 실행을 클릭합니다.

이 명령은 API 작업을 수행하고 vManage에서 받은 응답을 반환하며, 여기에는 다음 필드가 포함됩니다.

요청 URL

사용된 전체 URL. 여기에는 vManage 주소 및 입력한 모든 매개변수가 포함됩니다.  이는 성공적으로 세션을 인증한 해당 스크립트 또는 유틸리티에서 사용할 수 있습니다.

응답 본문

수신된 전체 응답 데이터

응답 코드

수신된 HTTP 상태 코드입니다.

응답 헤더

사용된 헤더.

관련 정보

Cisco Developer vManage API 설명서