API Postman 가이드라인

Postman은 HTTP 요청을 구성, 전송, 분석할 수 있는 사용자 친화적인 인터페이스를 제공하여 판매자 API를 테스트하고 이해하는 기능을 크게 향상합니다. 다양한 API 호출 (GET, POST, PUT, DELETE)을 다양한 엔드포인트로 쉽게 작성하고 수정하여 매개변수, 헤더, 요청 본문을 조정하여 실제 시나리오를 시뮬레이션할 수 있습니다.

상태 코드, 헤더, 페이로드를 비롯한 응답을 명확하게 표시하는 도구를 사용하면 API 동작을 빠르게 확인할 수 있으며 문제 디버깅에 도움이 됩니다. 이 구조화된 접근 방식을 사용하면 개발 수명 주기가 단축되고 API 품질이 개선되며 Merchant API의 기능과 복잡성에 대한 이해가 깊어집니다.

개요

Postman 인스턴스에서 MAPI Postman 컬렉션을 사용하려면 먼저 몇 단계를 따라 환경을 구성해야 합니다. 다음은 이 작업을 수행하는 방법에 관한 단계별 안내입니다.

플랫폼에 대한 자세한 내용은 Postman 설명을 참고하세요.

1. 서비스 계정 구성

serviceAccountKey와 api_key가 표시됩니다.

  1. 자세한 단계는 서비스 계정을 사용하여 API에 액세스하는 방법을 참고하세요.
  2. Google Cloud 프로젝트 > 사용자 인증 정보 > 사용자 인증 정보 만들기 > 서비스 계정
  3. 양식을 작성하고 만들기 및 계속을 클릭합니다.
  4. 소유자 역할을 선택하고 계속을 클릭합니다.
  5. 완료를 클릭합니다.
  6. JSON 키를 다운로드하려면 다음 단계를 따르세요.
    1. 방금 만든 서비스 계정 이메일({YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com)을 클릭합니다.
    2. 키 탭을 클릭합니다.
    3. 키 추가 > 키 만들기를 클릭합니다.
    4. JSON을 선택하고 만들기를 클릭하여 JSON을 다운로드합니다.

경고: 키는 한 번만 다운로드할 수 있습니다. 키를 분실한 경우 새 키를 만들고 이 키를 삭제해야 합니다.

  1. 판매자 센터를 엽니다.
  2. 설정 > 액세스 및 서비스에서 사용자 및 액세스를 클릭합니다.
  3. 사용자 추가를 클릭하고 서비스 계정 ID를 새 사용자의 이메일 주소로 사용합니다.

2. Postman 설정

  1. Postman 환경 템플릿 JSON 다운로드
  2. MAPI Postman 컬렉션 JSON 다운로드
  3. Postman에 로그인하거나 새 계정 만들기
  4. Postman 환경 템플릿 가져오기
    1. 전체 JSON을 환경 > 내 계정 > serviceAccountKey에 복사합니다.
    2. JSON에서 private_key를 복사하여 컬렉션의 Environment > MyAccount > api_key에 붙여넣습니다.
  5. MAPI Postman 컬렉션 JSON 가져오기
  6. 오른쪽 상단에서 환경을 선택합니다.

3. 개발자 등록

개발자로 등록하여 판매자 센터 계정을 Google Cloud 프로젝트에 연결합니다. API 개발자 역할을 가진 사용자는 필수 서비스 공지, 개발자 설문조사, 기회 등 API 커뮤니케이션을 받게 됩니다.

  1. Postman > Collections > Merchant API Official을 엽니다.
  2. accounts_v1 > accounts > accounts.developerRegistration > registerGcp를 엽니다.
  3. 경로의 {account} 자리표시자를 MC ID로 바꿉니다.
  4. 본문의 {email} 자리표시자를 이메일 주소로 바꿉니다.
  5. 보내기를 클릭하여 등록을 실행합니다.
  6. 모든 작업을 올바르게 완료했다면 다음과 같은 확인 JSON 응답이 표시됩니다. json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Postman에서 Merchant API 테스트

  1. Postman > Collections > Merchant API Official > accounts_v1 > accounts > list를 엽니다.
  2. Send를 클릭합니다.
  3. 모든 작업을 올바르게 완료했다면 다음과 같은 확인 JSON 응답이 표시됩니다. json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }