API를 사용하여 사용자 정의 애플리케이션 빌드

Discovery API를 사용하여 데이터를 검색하는 사용자 정의 애플리케이션 또는 컴포넌트를 빌드하십시오.

서비스 API 버전화

API 요청에는 version=YYYY-MM-DD의 날짜 형식을 사용하는 버전 매개변수가 필요합니다. 이전 버전과 호환되지 않는 API 변경이 발생할 때마다 API의 새 부 버전이 릴리스됩니다.

API 요청마다 버전 매개변수를 전송하십시오. 서비스는 지정한 날짜에 맞는 API 버전을 사용하거나 해당 날짜 이전의 가장 최신 버전을 사용합니다. 현재 날짜로 기본값을 지정하지 마십시오. 대신, 앱과 호환되는 버전과 일치하는 날짜를 지정하고 앱이 이후 버전에 대해 준비될 때까지 변경하지 마십시오.

현재 버전은 2023-03-31 입니다.

프로젝트 ID 가져오기 IBM Cloud

이 정보는 IBM Cloud 에만 적용됩니다.

API를 사용하려면 요청에 사용할 API 키( URL )를 구성해야 합니다. 많은 API 메소드에 프로젝트 ID가 필요합니다.

  1. IBM Cloud 리소스 목록에서 AI/Machine Learning을 펼친 후 Discovery 서비스 인스턴스의 서비스 페이지를 찾으십시오.

  2. 신임 정보 섹션에서 URL을 복사하십시오. API 요청에서 이 값을 {url} 로 지정합니다.

  3. 이 페이지에 있는 동안 API키를 복사하십시오. 이 값을 {apikey} 로 지정합니다.

  4. Discovery에서 프로젝트를 열고 통합 및 배치 > API 정보 페이지로 이동하십시오.

  5. 프로젝트 ID를 복사하십시오. 이 값을 {project_id} 로 지정합니다.

    컨텐츠 마이닝 프로젝트를 사용하는 경우 링크 공유 페이지를 계속 유지하십시오. 웹 브라우저의 위치 필드에서 /projects 로 시작하는 URL 을 복사하십시오. 예: projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. URL 의 /projects/ 세그먼트 뒤에 지정되는 ID는 프로젝트 ID입니다.

  6. 복사한 ID를 사용하여 요청 URL 을 작성하십시오.

    예를 들어, 다음 요청은 프로젝트의 콜렉션을 나열합니다.

    curl -X {request_method} -u "apikey:{apikey}" \
"{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"

{collection_id} 를 가져오기 위해 콜렉션 나열 API 메소드를 사용할 수 있습니다. 또는 제품 사용자 인터페이스에서 콜렉션을 열고 웹 브라우저 위치 필드에서 URL페이지의 /collections/ 세그먼트 뒤에 표시되는 콜렉션 ID를 복사하십시오.

API 사용 IBM Cloud Pak for DataIBM Software Hub

이 정보는 Discovery for Cloud Pak for Data 에만 적용됩니다.

API를 사용하려면 요청에 사용할 API 키( URL )를 구성해야 합니다.

  1. 웹 클라이언트의 메인 메뉴에서 서비스를 확장한 다음 인스턴스를 클릭합니다.

  2. 인스턴스를 찾은 후 클릭하여 해당 요약 페이지를 여십시오.

  3. 페이지의 액세스 정보 섹션으로 스크롤한 후 URL을 복사하십시오. 이 값을 {url}로 지정할 것입니다.

  4. 운반자 토큰도 복사하십시오. API를 호출할 때 이 토큰을 전달해야 합니다.

  5. 실행된 애플리케이션 인스턴스에서 통합 및 배치 > API 정보 페이지로 이동하십시오.

  6. 프로젝트 ID를 복사하십시오. 이 값을 {project_id} 로 지정합니다.

    컨텐츠 마이닝 프로젝트를 사용하는 경우 링크 공유 페이지를 계속 유지하십시오. 웹 브라우저의 위치 필드에서 /projects 로 시작하는 URL 을 복사하십시오. 예: projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. URL 의 /projects/ 세그먼트 뒤에 지정되는 ID는 프로젝트 ID입니다.

  7. 복사한 ID를 사용하여 요청 URL 을 작성하십시오.

    예를 들어, 다음 요청은 프로젝트의 콜렉션을 나열합니다.

    curl -H "Authorization: Bearer {token}" \
"{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"

관리자에 대해 생성된 베어러 토큰은 인스턴스에 대해 구성된 액세스 설정에 관계없이 모든 인스턴스에 액세스할 수 있습니다.

베어러 토큰은 12시간후에 만료됩니다. 세션 길이 사용자 정의에 대한 자세한 정보는 유휴 세션 제한시간 설정을 참조하십시오.

다음 단계

개발자는 다음과 같은 개선사항을 작성할 수 있습니다.