API 요청 전송

테스트 탭에 디버깅할 API에 대한 요청을 설정하려면 필드를 채우십시오.

API Designer UI 애플리케이션을 사용하거나 브라우저 기반 API Manager UI를 사용하여 이 태스크를 완료할 수 있습니다.

테스트 탭 열기

API Manager 또는 API Designer에 로그인하십시오.
탐색 목록에서 개발을 클릭한 후 API 탭을 선택하십시오.
테스트할 API의 제목을 클릭하십시오.
API 디자인 페이지의 페이지 헤더에서 테스트 탭을 클릭하십시오.

요청 섹션을 채우십시오.

페이지의 요청 섹션을 사용하여 요청 URL, 인증 메커니즘 및 요청 매개변수를 설정하십시오. 요청을 구성하는 데 필요한 필드를 채우려면 다음 단계를 완료하십시오.

참고: 테스트 탭은 베니티 엔드포인트를 지원하지 않습니다. API가 호출되는 게이트웨이 엔드포인트를 지정해야 합니다. 요청 필드는 기본적으로 게이트웨이 엔드포인트를 사용합니다.

보안 스킴을 채우려면 다음 단계를 완료하십시오.
1. 권한 부여 를 클릭하고 원하는 보안 정의를 선택하십시오. 사용 가능한 보안 정의는 API에서 이미 구성된 보안 스킴에 따라 다릅니다. 보안 스킴을 구성하는 방법을 알려면 보안 스킴 정의를 참조하십시오. 사용 가능한 보안 정의는 다음과 같습니다.
  - API 키
  - 기본
  - OAuth
2. API 정의가 보안 설정에 대해 API키 권한을 사용하는 경우 권한 부여 페이지의 다음 필드에 필요한 권한 부여 세부사항을 입력하십시오.
  
  이름
  
  보안 스킴에서 자동으로 채워지는 변수 이름입니다.
  
  위치
  
  위치는 보안 스킴에서 자동으로 채워집니다.
  
  값
  
  사용자는 자동으로 채워진 이름을 기반으로 값을 입력할 수 있습니다. 예를 들어 이름이 X- IBM -Client-Id인 경우 사용자는 값 필드에 동일한 이름을 입력할 수 있습니다.
  
  API키 보안 스킴에 대한 자세한 정보는 API키 보안 스킴 정의를 참조하십시오.
3. API 정의가 보안 설정에 대해 기본 권한을 사용하는 경우 권한 부여 페이지의 다음 필드에 필요한 권한 부여 세부사항을 입력하십시오.
  
  사용자 이름 및 비밀번호
  
  사용자 레지스트리를 사용하여 인증하는 데 필요한 사용자 이름 및 비밀번호를 입력하십시오.
  
  기본 보안 스킴에 대한 자세한 정보는 기본 인증 보안 스킴 정의를 참조하십시오.
4. API 정의에서 보안 설정에 OAuth 권한을 사용하는 경우 권한 부여 페이지의 다음 필드에 필요한 권한 부여 세부사항을 입력하십시오.
  참고:
  - OAuth 권한 부여는 기본 OAuth 제공자만 지원합니다. 기본 OAuth 제공자에 대한 자세한 정보는 기본 OAuth 제공자 구성 을 참조하십시오.
  - OAuth 권한에 사용 가능한 플로우 옵션은 다음과 같습니다.
    - 내재적
    - 액세스 코드
    - 자원 소유자 - 비밀번호
    - 애플리케이션
    권한 부여 페이지의 필드는 구성된 플로우를 기반으로 합니다. 예를 들어, 비밀번호 흐름에서는 인증 URL 필드를 사용할 수 없습니다.
  권한 부여 URL
  
  이 URL 는 사용자를 인증 및 권한 부여를 위해 리디렉션하는 데 사용됩니다. URL 는 리소스 페이지 에서 생성한 OAuth 제공자로부터 자동 입력됩니다.
  
  이름
  
  OAuth 제공자의 이름이 자동으로 채워집니다.
  
  클라이언트 ID
  
  이 ID는 자원에 대한 클라이언트의 액세스를 인증하고 권한을 부여하는 데 사용됩니다. 대상 구성에서 선택한 애플리케이션에 따라 자동으로 채워집니다. 자세한 정보는 API에 대한 테스트 환경 설정 지정을 참조하십시오.
  
  클라이언트 시크릿
  
  클라이언트 ID에 해당하는 비밀 키를 입력하십시오. 클라이언트 시크릿은 애플리케이션을 작성할 때 한 번만 표시됩니다. OAuth 권한 부여를 위한 비밀 키를 기록해 두십시오.
  
  플로우
  
  API 권한의 플로우는 권한을 얻는 프로세스를 판별하는 OAuth 플로우 유형을 참조합니다. 권한 부여에 대한 보안 스킴을 작성할 때 선택하는 플로우 유형에 따라 다릅니다. 이 필드는 기본적으로 자동으로 채워집니다.
  
  범위
  
  추가할 범위의 선택란을 선택하십시오. 범위는 OAuth 제공자에서 생성되는 액세스 토큰에 포함됩니다. OAuth 보호 API가 호출되면 게이트웨이는 액세스 토큰에서 전달되는 범위를 확인합니다. 그런 다음 보안 정의에서 허용되는 범위 목록과 비교하여 액세스 권한을 부여할지 여부를 판별합니다.
  
  토큰 URL
  
  이 OAuth 토큰( URL )은 인증 과정에서 OAuth 토큰을 얻기 위해 사용됩니다. 토큰(Token) URL 은 리소스 페이지에서 해당 OAuth 제공자를 생성할 때 추가하는 액세스 토큰( URL )을 기반으로 자동 입력됩니다.
  
  경로 재지정 URI
  
  목록에서 경로 재지정 URI를 선택하십시오.
  
  사용자 이름 및 비밀번호
  
  자원 페이지의 해당 OAuth 제공자 아래에서 선택된 사용자 레지스트리의 사용자 이름 및 비밀번호를 입력하십시오.
  
  토큰 가져오기 를 클릭하여 액세스 토큰을 작성하십시오.
  
  시스템은 사용자가 권한을 적용할 때 매개변수 탭에서 액세스 토큰을 자동으로 업데이트합니다.
  
  OAuth 보안 스킴에 대한 자세한 정보는 OAuth2 보안 스킴 정의를 참조하십시오.
5. 적용을 클릭하십시오.
  API를 호출할 때 API Connect 는 제공된 정보를 사용하여 헤더를 채웁니다.
작업을 선택하고 제공된 목록에서 작업 요청( URL )을 요청합니다.

매개변수 탭에서 헤더, 조회 및 경로 매개변수를 정의하십시오.

매개변수를 정의하고 키 필드에 매개변수 이름을 입력하며 찾을 위치 필드에서 조회, 헤더또는 경로 를 적절하게 선택하고 값 필드에 문자열 값을 제공할 수 있도록 빈 행이 제공됩니다. 새 매개변수를 정의하기 시작하면, 추가적으로 빈 행이 자동으로 추가됩니다.

기본 헤더 매개변수와 값이 제공됩니다. 예를 들어, API에 클라이언트 ID 또는 클라이언트 시크릿 정의가 적용된 경우 해당 키는 값이 사전 설정된 헤더 매개변수로 추가됩니다. 클라이언트 ID및 클라이언트 보안 정의 구성에 대한 세부사항은 API키 보안 정의 작성을 참조하십시오.

다음 테이블은 요청에서 사용되는 일부 공통 헤더 정의를 나열합니다.

표 1. 공통 요청 헤더
키	값	주석
승인	`미디어 유형/서브타입`	응답 헤더가 사용해야 하는 컨텐츠 유형을 지정합니다. 기본값은 `application/json`입니다.
X-IBM-Client-Id	`클라이언트_ID_val`	샌드박스 카탈로그에서 내장 테스트 애플리케이션을 사용 중인 경우 값은 자동으로 미리 채워집니다. 사용자 고유 클라이언트 애플리케이션을 사용 중인 경우 값을 애플리케이션의 클라이언트 ID로 대체하십시오.
X-IBM-Client-Secret	`클라이언트_비밀_값`	샌드박스 카탈로그에서 내장 테스트 애플리케이션을 사용 중인 경우 값은 자동으로 미리 채워집니다. 사용자 고유의 클라이언트 애플리케이션을 사용 중인 경우 값을 애플리케이션의 클라이언트 시크릿으로 대체하십시오..
권한 부여	무기명 `액세스 토큰`	토큰을 base64로 인코딩합니다. API Connect 가 사용자를 위해 토큰을 인코딩할 수 없습니다.
컨텐츠 유형	`미디어 유형/서브타입`	응답 본문에서 사용해야 하는 컨텐츠 유형을 지정합니다(예: `application/json` or `image/png`).

API에 정의된 경로 또는 쿼리 매개변수가 있는 경우 매개변수 목록에 추가되어 값을 입력할 수 있으며, 경로 및 쿼리 매개변수 구성에 대한 자세한 내용은 REST API의 경로 정의 및 작업 구성하기를 참조하세요.

오퍼레이션이 POST 또는 PUT이면, 요청 본문을 설정하십시오.
1. 본문 탭을 클릭하십시오.
2. 요청 본문에 대한 정보를 입력하십시오.

요청 전송

API 요청이 구성되면 전송을 클릭하여 호출을 실행합니다.

"응답 없음"을 나타내는 메시지가 표시되면 API 호출을 완료할 수 없습니다. 이 문제점의 가능한 원인은 다음과 같습니다.

API 정의에서 CORS가 사용되지 않음
API 정의를 편집하고 CORS를 사용으로 설정하십시오. 그런 다음, 변경사항을 저장하고 API를 공개하십시오. 클라이언트 앱을 사용하는 경우 공개 후 다시 API에 구독됨을 명심하십시오.
게이트웨이 서비스 URL에 올바르지 않은 인증서가 있음
지침에 따라 인증서를 허용하고 테스트를 계속 진행하십시오.
브라우저가 게이트웨이 서비스에 연결할 수 없습니다.