API 카탈로그 IP 기관 가이드

API를 쉽게 검색할 수 있도록 만들기

이 가이드에서는 IP 기관이 지적 재산권용 API 카탈로그를 통해 자신의 API를 제공하는 방법을 설명합니다.

API 카탈로그는 IP 기관이 제공하는 OpenAPI 사양(OAS) 파일에 따라 이러한 API를 자동으로 캡처할 수 있습니다. 아래 단계에 따라, API가 카탈로그에 포함되도록 할 수 있습니다.

참고: OAS 파일을 생성할 수 없는 경우, 이 엑셀 템플릿에 필요한 세부 사항을 입력한 후 이메일로 보내주시기 바랍니다.

1. API용 OAS 파일 생성하기

시작하려면 다음 주요 요구 사항을 충족하는 API용 OAS 파일을 생성하세요:

OAS 파일에 대한 최소 데이터 표준

아래 표에는 OAS 파일에 필요한 최소 필드 세트가 나열되어 있습니다.

아래에 제공된 확장 OAS 필드는 Swagger의 Open API 확장 사양 에서 제공하는 지침에 따라 'x-'로 표시되어 있습니다.

템플릿에서 정의된 필드에 대한 값을 제공할 수 없는 경우, 해당 필드를 API 카탈로그에서 '수동 입력'으로 지정하세요. 향후 업데이트에서는 수동 편집을 피하기 위해 OAS 파일에 확장 스키마를 추가해야 합니다.

OAS 필드 데이터 유형 설명
openapi: String 사용된 Open API 사양 버전(3.0.x 사용 권장)
Info Object:
- title: String API 이름
- description: String API에 대한 설명(가급적 사용 사례를 설명하는 형식으로 작성하는 것이 좋습니다. 예를 들어, 이 API는 사용자가 [실행]을 할 수 있도록 [기능]에 대한 액세스를 제공합니다.)
- version: String API용 OAS 파일의 버전. 1.0.1 형식을 사용하는 것이 좋습니다.
- x-oas-url: String OAS 파일을 다운로드할 수 있는 페이지의 URL 링크(이는 자동 스크래퍼가 정기적으로 페이지에서 OAS 파일에 대한 업데이트를 확인할 수 있습니다.)
- x-product-page-url: String 웹사이트에 API가 설명되어 있는 제품 페이지의 URL 링크(이는 API 카탈로그의 사용자가 자신이 찾는 API를 직접 참조할 수 있게 한다.)
- x-ip-domain Array[String] 이 API 기능과 관련된 모든 IP 도메인 영역을 나열합니다: 특허, 상표, 산업 디자인, 저작권, 지리적 표시, 식물 품종 보호, 집적 회로 레이아웃 설계
- x-service-type Array[String] API가 제공할 수 있는 모든 서비스 유형을 나열합니다: 계정 관리, 애플리케이션 관리, 커뮤니케이션, 배포, 결제, 포트폴리오 관리, 등록, 검색, 번역(각 서비스 유형에 대한 자세한 설명은 아래를 참조하세요.)
- x-content-type Array[String] API가 제공할 수 있는 모든 콘텐츠 유형을 나열합니다: 초록, 서지 데이터, 인용 데이터, 청구항, 분류, 법원 판결, 설명, 대응 특허 데이터, 전문, 법적 상태 데이터, 라이선스 데이터, 의견 제출 통지 데이터, 결제 관련 데이터, 용어 데이터(각 콘텐츠 유형에 대한 자세한 설명은 아래를 참조하세요).
- x-content-language Array[String] API가 응답할 수 있는 모든 콘텐츠 언어를 쉼표로 구분하여 ISO 639-1 세트 1 형식으로 나열합니다.
- contact Contact Object
Contact Object:
- email String API에 대해 문의할 팀의 이메일
- name String 기관 이름
- URL String 기관 API 카탈로그 사이트 또는 개발자 포털의 홈페이지 URL
경로 객체: Path Item Object 개별 엔드포인트와 해당 작업에 대한 상대 경로를 보유합니다. 전체 URL을 구성하기 위해 서버 객체의 URL에 경로를 추가합니다.
/(for each path...)
- summary: String 이 경로의 모든 작업에 적용하기 위한 문자열 요약
- get/put/post/delete 이 경로에 대한 GET/PUT/POST/삭제 작업의 정의
- responses Responses Object  
-- HTTP Status Code Response Object  
--- description String 응답에 대한 설명
--- content Map [String, Media Type Object] 콘텐츠 유형 응답 형식, 예를 들어, application/json 또는 application/pdf 등

2. OAS 파일 게시

정적 URL을 사용하여 웹사이트에 OAS 파일을 게시합니다. 또한 OAS 사양을 직접 스크래핑하는 것을 방해하는 추가 제약 조건이 없는지 확인하세요. 예를 들어, 사양을 ZIP 파일로 게시합니다.

중요: 초기 OAS 파일에 OAS URL 또는 API 제품 페이지 URL을 포함할 수 없는 경우, 위에 'x'로 표시된 OAS 필드를 추가하여 OAS 파일을 업데이트하고 새 버전으로 다시 게시하십시오. 이러한 변경 사항을 적용했음을 표시하도록 버전을 업데이트하는 것을 잊지 마세요!

3. OAS 파일 URL을 국제 사무국과 공유하세요.

OAS URL을 WIPO 국제 사무국에 이메일로 보내세요. 다른 모든 필수 정보는 OAS 파일에 제공된 세부 정보를 사용하여 자동으로 스크랩됩니다.

4. 새 API 항목을 받으면 유효성을 검사합니다.

위의 3단계를 완료하면, API에 대한 세부 정보가 포함된 이메일을 받게 됩니다.

이메일에서, 필수 입력란이 잘못되었거나 비어 있는 경우, 관련 데이터를 OAS 파일에 추가하고 다시 게시한 후 국제 사무국에 다시 전송하세요.

참고: "단일 정보 출처"를 유지하기 위해 모든 권장 데이터 필드를 포함하도록 OAS 파일을 정기적으로 업데이트하세요." 이렇게 하면 일관성이 보장되고 수동 업데이트의 필요성이 줄어듭니다.

API 카탈로그에 이용 가능한 필터

다음 표에는 이용 가능한 필터가 요약되어 있습니다. 하나 이상의 필터를 동시에 설정할 수 있습니다.

필터 라벨 기능 옵션
IP 도메인 API에서 반환되는 지적 재산권 콘텐츠 유형별 필터링

다음 중 하나 이상을 선택합니다:

  • 특허
  • 상표
  • 산업 디자인
  • 저작권
  • 지리적 표시
  • 식물 품종 보호
  • 집적 회로 레이아웃 설계
API 서비스 유형 API가 제공하는 서비스 유형 또는 기능 유형별 필터링

다음 중 하나 이상을 선택합니다:

사용자 계정 생성 및 유지 관리를 위한 서비스

IP 출원서 작성 및 제출을 포함한 IP 출원의 출원 서비스

예컨대 IP 관청과 관련 IP 소유자, 이를테면 출원인 또는 그 대리인 간의 의견제출통지서를 포함한 심사 관련 또는 수수료 관련 커뮤니케이션을 포함하는 커뮤니케이션

IP 출원의 공개, 법적 상태 데이터, 법원 판결 데이터, 초록, 인용 데이터, 분류 데이터, 전문 데이터 등 다양한 데이터의 보급...

출원 수수료, 갱신 수수료 등 각종 수수료에 대한 결제 서비스

IP 권리 소유자/보유자 또는 그 대리인의 IP 포트폴리오 관리를 위한 서비스

절차 세부 사항을 포함하여 IP 출원에 대해 공개적으로 이용 가능한 정보를 제공하는 서비스

키워드 검색 또는 출원 번호 검색과 같은 특정 쿼리를 기반으로 정보를 검색하는 서비스

IP 문서 또는 데이터 번역 서비스
콘텐츠 유형 API가 반환한 콘텐츠 유형별로 API를 필터링

다음 중 하나 이상을 선택합니다:

IP 문서의 내용의 간결한 요약

TIP 문서에 대한 설명 정보. 일반적으로 발명의 명칭, 출원인 또는 양수인, 출원일, 공개일 및 기타 관련 행정 및 절차 세부 사항이 포함됩니다.

특허 문서에서 선행 특허 (특허 인용) 또는 비특허 문헌 (NPL 인용)의 참조

특허가 부여하는 보호 범위로, 특허의 적용 범위를 결정합니다.

IP 문서는 주제에 따라 다양한 부류 및 하위 부류로 분류됩니다. 여기에는 특허의 경우 IPC/CPC, 상표의 경우 니스, 산업 디자인의 경우 로카르노가 포함됩니다.

IP 문제와 관련된 법원 소송의 법적 판결에 대한 정보와 세부 사항

본 발명에 대한 자세한 설명

하나의 최초 출원에서 비롯된 관련 IP 문서 모음

특허 출원 또는 등록 특허에서 발명 또는 창작에 대한 완전하고 상세한 설명

특정 IP 출원의 법적 상태 이벤트 기록이 있거나 없는 특정 IP 출원의 현재 법적 상태; 또는 지정된 주 또는 월 등 지정된 기간 동안 발생한 IP 출원의 법적 상태 이벤트 데이터 집합. 사무소는 WIPO 표준 ST.27, ST.61 또는 ST.87 에 따라 정보를 제공하도록 권장됩니다.

IP 라이선스 관련 데이터

조사 보고서, 심사 결과 (예: 거절 또는 등록 결정), 의견제출통지서에 대한 답변 (예: 보정 또는 의견 제출) 또는 관련 행정 정보 (예: 출원 마감일 또는 수수료 납부) 등 의견제출통지서와 관련된 데이터

통화 등 수수료 결제와 관련된 데이터

IP 영역에서 사용되는 특정 용어 및 정의
기관 API를 제공하는 기관별 필터링 기관 이용 가능한 중 하나 이상을 선택합니다.
응답 언어 API가 반환하는 콘텐츠의 언어별 필터링 이용 가능한 언어 중 하나 이상을 선택하세요.
응답 형식 API가 반환하는 콘텐츠의 파일 형식별로 API를 필터링

다음 중 하나 이상을 선택합니다:

  • JSON
  • XML
  • IMG(TIFF,PNG, …)
  • PDF
  • TXT
  • DOCX
  • 사운드
  • 멀티미디어
  • 3D
  • ZIP
API 프로토콜 API가 REST인지 SOAP인지에 따라 API를 필터링

REST 또는 SOAP 중 하나를 선택합니다.

  • REST
  • SOAP
API 작업 API를 통해 이용 가능한 작업별로 API를 필터링

다음 중 하나 이상을 선택합니다:

  • GET
  • PUT
  • POST
  • DELETE

연락처

API 카탈로그에 대해 더 궁금한 점이 있으면 문의해 주세요.

귀하의 온라인 경험을 개선하기 위해 쿠키 및 기타 식별자를 사용합니다. WIPO 웹사이트를 이용함으로써 귀하는 이에 동의하게 됩니다. 개인정보 취급 방침에 대해 자세히 알아보세요.