Postman을 사용하여 Cato 사이트 생성 API 활용

이 문서에서는 Postman API 클라이언트를 사용하고 Cato 관리 애플리케이션에서 사이트를 설정하는 Cato API를 실행하는 방법을 설명합니다.

Postman 구성 개요

Cato의 구성 API를 실행하여 사이트를 설정하고 업데이트하기 위해 Postman을 구성하는 방법에 대한 개요입니다.

API 키는 API 클라이언트가 Cato 계정에 인증하는 데 사용하는 코드입니다. Cato 관리 애플리케이션의 API 관리 화면을 사용하여 편집 권한이 있는 API 키를 생성할 수 있습니다.

Cato 생성 API를 위한 API 키를 생성하려면:

탐색 메뉴에서 리소스 > API 키를 클릭합니다.
API 키 탭에서 새로 만들기를 클릭합니다. API 키 생성 패널이 열립니다.
키 이름을 입력합니다.
API 권한을 편집으로 설정합니다.
API 키의 만료일을 설정할 것을 권장합니다.
적용을 클릭합니다. API 키가 추가되며 새 API 키가 포함된 팝업 창이 표시됩니다.
(복사)를 클릭하고 Cato 관리 애플리케이션에서 생성된 API 키를 복사하여 안전한 위치에 저장합니다.

이 창을 닫으면 API 키 값을 다시 접근할 수 없습니다.
팝업 창을 닫으려면 확인을 클릭합니다.

Cato 생성 API로 사이트 설정을 시작할 수 있도록 사용자 정의된 Postman 컬렉션 및 환경을 만들었습니다. 이 사용자 정의 파일들은 Cato 저장소에서 사용할 수 있습니다.

Postman 환경에는 변수(API URL, CMA 계정 ID 등...)가 포함되어 있으며 Postman 컬렉션에는 GraphQL 변형 API 호출 예제가 포함되어 있습니다. 이를 가져오려면 '가져오기'를 클릭하고, 파일을 창에 드롭한 후 가져오기를 클릭합니다:

Cato API의 컬렉션 및 환경을 Postman에 추가하려면:

사용자 정의 환경이 이제 Postman 환경에 표시됩니다:

사용자 정의 컬렉션이 이제 Postman 컬렉션에 표시됩니다:

각 Cato 테넌트에 대해 CM 계정 ID 및 API 키를 저장할 별도의 Postman 환경을 사용할 것을 권장합니다.

새로운 Postman 환경을 생성하려면:

환경 탭에서 템플릿 _cat_env_template_를 마우스 오른쪽 버튼으로 클릭하고 복제를 선택합니다.
환경의 복사본을 마우스 오른쪽 버튼으로 클릭하고 이름 변경을 선택한 다음, 환경의 이름을 Cato 테넌트의 이름으로 변경합니다.
API 키와 CMA 계정 ID를 복사하여 환경의 해당 필드의 현재 값에 붙여넣고 저장을 클릭합니다.

CMA 계정 ID를 URL에서 직접 가져올 수 있습니다:

Postman을 위한 API 키와 CMA 계정 ID를 정의한 후

API 호출을 실행하고 사이트를 설정하려면:

컬렉션 탭에서.
오른쪽 상단 모서리에서 이전 단계에서 생성한 환경을 선택합니다.
컬렉션 탭에서 Cato Mutation API v1 > addSocketSite > _query를 확장하고 query_stateCode를 선택합니다.
API 호출을 실행하려면 전송을 클릭합니다. 예상 결과는 200 OK 및 일부 데이터입니다.