vManage에서 API를 실행하도록 Postman 구성

소개

이 문서에서는 Postman과 함께 API(Application Programming Interfaces)를 실행하는 방법에 대해 설명합니다.

시스템 요구 사항

• Postman 설치됨
• vManage, 사용자 이름 및 비밀번호 자격 증명에 대한 액세스

참고: Postman이 없는 경우 https://www.postman.com/downloads/에서 다운로드하십시오.

배경 정보

가장 일반적으로 사용되는 HTTP 동사(또는 적절히 호출되는 메서드)는 POST, GET, PUT, PATCH 및 DELETE입니다.

이는 각각 생성, 읽기, 업데이트 및 삭제(또는 CRUD) 작업에 해당합니다.

다른 동사들도 많이 있지만 활용도가 낮습니다. 빈도가 낮은 방법으로는 OPTIONS와 HEAD가 다른 방법보다 더 자주 사용됩니다.

API를 실행하도록 Postman 구성

1단계. Postman을 열고 새 HTTP 요청을 생성합니다.

강조 표시된 옵션을 클릭하면 새 HTTP 요청을 생성할 수 있습니다.

새 HTTP 요청을 생성합니다.

2단계. vManage에 대한 사용자 이름 및 비밀번호 자격 증명으로 인증합니다.

다른 HTTP 요청을 생성합니다.

1. POST를 HTTP 동사로 선택합니다.
2. POST 옆에 https://<vmanage-ip>/j_security_checkbox를 추가합니다.
3. Body(본문)를 클릭하고 KEY 매개변수 j_username 및 j_password와 해당 값을 각각 추가합니다.
4. Send(보내기)를 클릭합니다.

참고: 이 예에서 vManage ip 주소는 10.88.244.30이고 포트는 5301입니다

참고: 사용자 이름 및 비밀번호 값으로 admin을 사용합니다.

Postman에서 매개변수를 Fullfil합니다.

vManage 인증.

주의: 이 API 호출의 응답은 비어 있어야 합니다.

3단계. 토큰 요청

1. GET을 HTTP 동사로 선택합니다.
2. GET https://<vmanage-ip>/dataservice/client/token 옆에 API 호출 세부 정보를 추가합니다.
3. Send(보내기)를 클릭합니다.

참고: vManage 버전 19.2.1부터 성공적으로 로그인한 사용자는 API 호출을 통해 각 POST/PUT/DELETE 작업에 대해 X-XSRG-TOKEN 또는 CSRF 토큰을 보내야 합니다.

API 호출이 실행되면 본문에서 응답 문자열을 가져옵니다. 그 문자열을 저장합니다. 표시된 이미지는 Postman의 출력을 보여 줍니다.

vManage용 토큰 요청

경고: 이미지에 표시된 대로 토큰을 가져오지 못한 경우 이 단계를 반복하십시오.

4단계. vManage에 다른 API를 실행합니다.

이 예에서는 POST 요청을 수반합니다

1. 실행할 API 호출을 선택합니다. 이 경우에는 https:///dataservice/statistics/dpi/aggregation입니다.

팁: 다른 API 호출을 탐색하려면 vManage url https://vmanage-ip:port/apidocs으로 이동하십시오.

2. API 호출 본문을 수집합니다.

참고: 이 API 호출에는 JSON 형식의 본문이 포함되어 있습니다.

3. 헤더를 클릭하고 키로 문자열 X-XSRF-TOKEN을 값으로 추가합니다.

4. 발송을 클릭합니다.

표시된 그림에는 API 호출이 어떻게 표시되어야 하는지 표시됩니다.

DPI 어그리게이션 API 호출.

5단계. 세션 닫기

vManage 및/또는 디바이스에서 필요한 모든 정보를 검색한 후에는 vManage의 리소스를 해제하고 악의적인 사용자가 세션을 사용할 가능성을 제거합니다.

자동화된 환경에서 API 호출 실행

후속 API 호출에 사용할 쿠키 및 변수 저장

변수에 토큰을 저장하는 방법?

다음에 다시 사용할 수 있도록 토큰을 변수에 저장합니다.

변수에 토큰 저장

우리가 JSON 형식으로 토큰을 요청하면 저장해요. 테스트 탭을 사용하여 표시된 행을 붙여 넣습니다.

var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("token", jsonData.token);

pm.test("Status code is 200", () => {
 pm.expect(pm.response.code).to.eql(200);
});