API 호출

플랜을 선택하고 애플리케이션 코딩을 시작했으면 API를 호출할 오퍼레이션 URL을 검색해야 합니다.

오퍼레이션 ULR을 검색하려면 다음 단계를 완료하십시오.

1. API 제품을 클릭한 후 제품을 선택하십시오.
2. 작업할 API를 클릭하십시오.
   API 개요 페이지가 열립니다.
3. 필요한 작업을 선택한 다음 엔드포인트를 복사합니다.
   이것은 애플리케이션이 호출하는 URL이며, URL 구조는 다음과 같이 정의됩니다.

   API 유형	URL
   REST API	https://host/org/catalog/api/operation
   SOAP API	WSDL의 모든 조작에 대해 https://host/org/catalog/api .

   여기서,

   • 호스트는 게이트웨이 클러스터의 정규화된 호스트 이름입니다.
   • org는 조직의 URL 경로입니다.
   • 카탈로그는 카탈로그의 이름입니다.
   • api 는 API의 이름입니다.
   • operation은 오퍼레이션의 URL 경로입니다.
4. 매개변수, 요청 본문 및 응답 본문을 기록해 두십시오. 애플리케이션을 코딩하여 예상 요청을 작성하고 예상 응답을 처리하십시오.

API에 대한 사용 중인 애플리케이션 식별 설정에 따라 클라이언트 ID 또는 클라이언트 ID와 클라이언트 시크릿을 제공해야 할 수 있습니다. 이렇게 하려면 다음 단계를 완료하십시오.

5. 클라이언트 ID를 찾으려면 다음 단계를 완료하십시오.
   1. 앱을 클릭한 후 작업할 애플리케이션 이름을 클릭하십시오.
   2. 클라이언트 ID 표시 확인란을 선택합니다.
      클라이언트 ID가 표시됩니다.
   3. 클라이언트 ID에 헤더 매개변수 제공 &client_id=
      예를 들어, API에서 사용되는 URL은 다음과 같습니다.

      https://host/org/catalog/api/quote?loanAmount=20000

      그러나 클라이언트 ID 1234를 사용하여 호출하는 경우 URL을 다음으로 변경하십시오.

      https://host/org/catalog/api/quote?loanAmount=20000&client_id=1234

      참고: 클라이언트 ID는 애플리케이션을 등록할 때 API Connect 에 의해 자동으로 생성됩니다. 하지만 CLI 또는 REST API를 사용하여 사용자 정의 클라이언트 ID를 지정하는 경우 길이가 512바이트를 초과해서는 안됩니다. 해당 길이를 초과하는 경우 게이트웨이에서 API 요청을 거부하고 401 오류를 리턴합니다.
6. 애플리케이션을 등록하면 클라이언트 시크릿이 생성됩니다. 조회 매개변수 &client_secret=를 사용하여 클라이언트 시크릿을 제공하십시오. 애플리케이션을 등록할 때 클라이언트 시크릿을 기록하지 않은 경우 이를 재설정해야 합니다. 자세한 정보는 애플리케이션 관리를 참조하십시오.

클라이언트 ID 또는 클라이언트 ID와 시크릿이 URL과 함께 로그될 수 있습니다. 일반적으로 웹 서버는 클라이언트 시크릿을 누설할 수 있는 액세스 로그에 URL을 로그합니다. 클라이언트 ID 또는 시크릿을 URL에 노출하지 않으려면 다음 단계를 완료하십시오.

7. 클라이언트 ID의 경우, 애플리케이션이 API를 호출할 때 보내는 HTTP 메시지의 일부로 X-IBM-Client-Id 헤더를 설정합니다.
   예를 들어, URL 명령문은 다음과 같습니다.

   curl --header "X-IBM-Client-Id: 1234" https://host/org/catalog/api/quote?loanAmount=20000

   참고: 클라이언트 ID는 애플리케이션을 등록할 때 API Connect 에 의해 자동으로 생성됩니다. 하지만 CLI 또는 REST API를 사용하여 사용자 정의 클라이언트 ID를 지정하는 경우 길이가 512바이트를 초과해서는 안됩니다. 해당 길이를 초과하는 경우 게이트웨이에서 API 요청을 거부하고 401 오류를 리턴합니다.
8. 클라이언트 시크릿의 경우, 애플리케이션이 API를 호출할 때 보내는 HTTP 메시지의 일부로 헤더 X-IBM-Client-Secret 를 설정합니다.
   예를 들어, URL은 다음과 같습니다.

   https://host/org/catalog/api/quote?loanAmount=20000

   다음 HTTP 헤더를 설정하십시오.

   X-IBM-Client-Id=1234
   X-IBM-Client-Secret=ABCD