Postman을 사용하여 첫 API 호출

Postman은 API 작업을 쉽게 수행할 수 있도록 설계된 플랫폼입니다. 이 항목에서는 Postman을 사용하여 첫 번째 API 호출을 수행하는 방법을 안내합니다.

Postman은 API 호출을 쉽게 하고 테스트할 수 있는 API 플랫폼입니다. 웹훅 테스트, WebSocket 서버에서 데이터 송수신 등과 같은 API와 관련된 대부분의 모든 작업에 Postman을 사용할 수 있습니다. 이 주제에서는 첫 번째 API 호출을 수행하기 전에 Postman에서 완료해야 하는 단계와 Postman을 사용하여 주니퍼 Mist RESTful API에 대한 첫 번째 API 호출을 수행하는 방법을 다룹니다.

보다

우편배달부 설정

Postman을 사용하려면 Postman 웹 사이트를 사용하거나 Postman 다운로드에 설명된 대로 Postman 응용 프로그램을 다운로드할 수 있습니다.

Postman 웹 사이트 또는 애플리케이션에서 Postman에 로그인(또는 계정 만들기)합니다. 이렇게 하면 환경을 저장할 수 있습니다. 이 항목의 아래쪽에 있는 환경 생성 섹션을 참조하십시오.
계정이 생성되면 작업 공간에 액세스할 수 있습니다. 여기에서 API 호출을 저장하고 Mist API와 상호 작용하도록 환경을 구성할 수 있습니다.

Mist API 컬렉션 가져오기

그런 다음으로 Mist API 컬렉션을 가져옵니다. 주니퍼 Mist는 Postman 작업 공간으로 직접 가져올 수 있는 Postman API 호출 목록을 구축했습니다. 이 목록은 유지 관리되며 API 문서에 나열된 것과 일치합니다.

주니퍼 Mist Postman 컬렉션 페이지로 이동하여 Mist Cloud API 컬렉션을 선택합니다.
컬렉션이 열리면 Postman의 포크 컬렉션 및 환경에 설명된 대로 포크를 클릭합니다. 이렇게 하면 사용자 고유의 작업 영역에 컬렉션의 복사본을 만들고 기본 컬렉션이 업데이트될 때 업데이트를 계속 받을 수 있습니다.
Postman의 왼쪽 상단 모서리에 컬렉션이 이제 작업 공간으로 분기된 것을 볼 수 있습니다. 컬렉션과 해당 하위 섹션을 확장하여 RESTful API 호출이 어떻게 구성되는지 확인합니다.

환경 생성

postman 환경을 사용하면 여러 API 호출 및 컬렉션에서 재사용할 수 있는 프로필에 변수를 저장할 수 있습니다. Postman에서 API 호출을 시작하기 전에 환경을 만들고 변수를 정의해야 합니다.

환경 만들기에 설명된 대로 환경을 만들고 이름을 지정합니다.

환경 변수 추가에 설명된 대로 Postman 환경에서 변수를 테이블에 입력하여 정의합니다.

Mist RESTful API와 상호 작용하려면 다음 변수를 설정해야 합니다.

표 1: 환경 변수
변수	설명
`host`	이것은 Mist API 엔드포인트의 URL입니다. 예를 들어, `api.mist.com` 는 GLOBAL 01 클라우드에 액세스하는 데 사용됩니다. Mist API 엔드포인트 및 글로벌 리전의 전체 목록은 Mist 엔드포인트 및 글로벌 리전 을 참조하십시오.
`apitoken`	Mist API에 Postman을 인증하는 데 필요한 Mist API 토큰입니다. REST API용 Mist API 토큰을 생성하는 방법에 대한 자세한 내용은 API 토큰 생성을 참조하십시오.
`org_id`	이것은 Mist 조직의 UUID입니다. 조직 ID를 검색하는 방법에 대한 자세한 내용은 조직 ID 찾 기 및 조직 가져오기를 참조하세요.
`site_id`	특정 Mist 사이트의 UUID입니다. 사이트 ID를 검색하는 방법에 대한 자세한 내용은 사이트 정보 가져오기를 참조하세요.

모든 변수를 입력했으면 저장을 선택합니다.
페이지의 오른쪽 위 모서리에 있는 환경 드롭다운 메뉴로 이동하여 Postman 작업 영역에 환경을 적용한 다음, 새로 만든 환경을 선택합니다.

첫 API 호출 테스트

이제 컬렉션 및 환경으로 Postman을 설정했으므로 첫 번째 API 호출을 수행할 차례입니다. 이 예제에서는 API를 호출하여 API에 대한 연결을 테스트합니다. 이것은 호출을 GET /api/v1/self 사용하여 수행됩니다.

주니퍼 Mist API에 대한 첫 번째 API 호출을 테스트하려면 다음 단계를 따르십시오.

Postman의 왼쪽 메뉴에서 Collections(컬렉션)를 선택한 다음 Authentication > Self(자신 인증)로 이동합니다. 마지막으로 요청을 선택합니다GET getSelf.
보내기 단추를 선택합니다.

참고:
요청은 GET /api/v1/self 환경의 및 {{host}} 변수를 {{apitoken}} 사용합니다.
Mist API로부터 요청이 성공했음을 알리는 응답 코드를 받게 200 됩니다. 요청에 GET /api/v1/self 대한 응답으로 JSON 페이로드에서 계정 및 권한에 대한 정보를 수신합니다.

응답을 받지 못한 경우 Postman의 왼쪽 하단 모서리에 있는 콘솔 단추를 선택하여 보낸 요청과 받은 응답에 대한 자세한 정보를 수집합니다. HTML 응답 코드를 연구하여 응답을 받은 이유를 이해하십시오. 다음은 몇 가지 예제 오류 코드입니다.
- Error 404- 이는 엔드포인트 URL이 존재하지 않음을 의미합니다. 변수가 올바르게 구성되었는지 확인합니다 {{host}} . 예를 들어 URL에 추가 / 항목을 추가하면 응답 코드가 발생합니다 Error 404 .
- Error 401- 이는 API 호출을 보낼 권한이 없음을 의미합니다. Mist API의 응답을 검토하여 제대로 설정되지 않은 사항을 파악합니다. 변수가 올바르게 구성되었는지 확인합니다 {{apitoken}} .
HTML 응답 코드에 대한 자세한 내용은 REST API HTTP 응답 코드를 참조하십시오.

방금 Mist API에 첫 번째 API 호출을 보냈습니다. 이제 다른 호출을 탐색하고 테스트할 준비가 되었습니다. 다음은 다음에 테스트할 수 있는 몇 가지 제안 사항입니다.
- Orgs / Sites / getOrgSites
- Orgs / Devices Stats / getOrgDevicesStats
- Orgs / Templates / getOrgsTemplates
- Orgs / Inventory / getOrgInventory