APIカタログに関する、知財管理機関のためのガイド
API を見つけやすくするために
このガイドでは、知財管理機関が知的財産のAPIカタログを通じてAPIを提供する方法について説明します。
API カタログでは、知財管理機関による OpenAPI仕様 (OAS) ファイルの提供に基づいて、API を自動的にキャプチャできます。以下の手順によれば、API が確実にカタログに含まれるようになります。
注: OASファイルを作成できない場合は、このEXCELテンプレート に必要な詳細を記入しメールでお問い合わせください。
1. APIのOASファイルを作成する
はじめに、以下の主要な要件を満たすAPIの OASファイルを作成します。
- バージョン: OASバージョン3.0.xを使用します(3.0.0が推奨されます)。
- テンプレート: 提供されているテンプレートを使用して、OASファイルが最小要件を満たしている: (JSON, YAML).
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の使用に関する説明を提供する形式が好ましい。たとえば：このAPIは、ユーザーが[動作・操作]を行えるよう、[機能]へのアクセスを提供します。） |
| - version: | String | API に対するOASファイルのバージョン。1.0.1の形式の使用をお勧めします。 |
| - x-oas-url: | String | OASファイルをダウンロードできるページへのURLリンク（これにより、自動スクレイパーは、OASファイルに対して行う更新に関するページを定期的にチェックできるようになります） |
| - x-product-page-url: | String | Web サイト上で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 set 1 形式においてコンマで区切ってリストアップします。 |
| - contact | Contact Object | |
| Contact Object: | ||
| String | APIについて連絡するチームの電子メール | |
| - name | String | 機関の名称 |
| - URL | String | 機関のAPI Catalogサイトまたは開発者ポータルのホームページのURL |
| パス・オブジェクト: | Path Item Object | 個々のエンドポイント及びその操作への相対パスを保持します。パスは、完全なURLを構築するために、サーバ・オブジェクトからURLに追加されます |
| /(for each path...) | ||
| - summary: | String | このパスのすべての操作に適用することを目的とした文字列のサマリー |
| - get/put/post/delete | このパスに対するGET/PUT/POST/DELETE操作の定義 | |
| - responses | Responses Object | |
| -- HTTP Status Code | Response Object | |
| --- description | String | レスポンスの説明 |
| --- content | Map [String, Media Type Object] | コンテンツ・タイプのレスポンスの形式、例： application/json、application/pdfなど |
2. OASファイルを公開
静的URLを使用してOASファイルをWebサイト上で公開します。OAS仕様を直接スクレイピングすることの妨げとなるような要素が他にないことを確認してください。（例：仕様をZIPファイルとして公開するなど）。
重要: 当初の OAS ファイルにOAS URL または API製品ページのURL を含めることができなかった場合は、上述の「x」で示される OASフィールドでOASファイルを更新し、新しいバージョンとして再公開してください。これらの変更を行ったことを示すため、バージョンを更新することを、忘れないでください！
3. OASファイルのURLを国際事務局と共有する
OAS URLをWIPO国際事務局 に電子メールで送信して下さい。他に必要な情報はすべて、OASファイルに含まれる詳細を使用して自動的にスクレイピングされます。
4. 新しいAPIエントリを受け取り、検証する
上記ステップ3が完了すると、API の詳細が記載された電子メールが届きます。
電子メールにおいて、必須フィールドが正しくないか空白の場合は、必要なデータをOASファイルに追加して再公開してから、国際事務局に再送信してください。
注:「信頼できる唯一の情報源」（SSOT）を維持するために、推奨されるすべてのデータフィールドを含めるよう、OASファイルを定期的に更新してください。これにより、一貫性が確保され、手動での更新の必要性が低減されます。
API カタログに対し使用可能なフィルター
次の表では、使用可能なフィルターをまとめてあります。1つ以上のフィルターを同時に設定できます。
| フィルターのラベル | 機能 | オプション |
| IPドメイン | API によって返される知的財産コンテンツの種類をフィルタリングします | 次のうち1つ以上を選択します:
|
| API サービスの種類 | API が提供するサービスまたは機能の種類をフィルタリングします | 次のうち1つ以上を選択します: ユーザアカウントの作成・メンテナンスのサービス 出願に関連するサービス（出願文書の作成及び提出を含む） 知財庁と知財所有者側との間の連絡（出願人・代理人などのための、審査や手数料に関する連絡を含む、オフィスアクション関連の連絡など） 出願公開、リーガルステータスのデータ、裁判所の判決データ、要約、引用のデータ、分類データ、全文データなどのデータの配信 出願手数料や維持費など各種手数料の支払いに関するサービス 知財権者または代理人の知財ポートフォリオの管理のためのサービス 手続きの詳細を含む、出願に関する公開情報を提供するサービス キーワード検索や出願番号による検索など、特定のクエリに基づく情報取得のためのサービス 知財関連の文書またはデータの翻訳サービス |
| コンテンツの種類 | API によって返されるコンテンツの種類をにより、APIをフィルタリングします | 次のうち1つ以上を選択します: 出願文書の内容の要約 出願文書に関する説明：通常、発明の名称、出願人または譲受人、出願日、公開日、その他の管理や手続きに関する詳細等を含む 出願文書による従来技術（特許文献や非特許文献）の参照 特許により保護される範囲：特許の適用範囲を特定 出願文書は、発明の主題に基づき、クラスおよびサブクラスに分類されます。例えば、特許のIPC／CPC、商標のニース、工業意匠のロカルノが含まれます 知財に関連する判決の情報および詳細 発明の詳細な説明 最初の単一の出願から派生した関連出願文書のまとまり 特許出願または取得特許における発明または創作の、完全かつ詳細な説明 特定の出願の現在のリーガルステータス（リーガルステータス・イベント履歴の有無によらない）；あるいは、特定の期間（週や月など）において出願に対して発生したリーガルステータス・イベントのデータセット。知財庁は、WIPO Standard ST.27、ST.61、またはST.87に従い情報を提供して下さい ライセンスに関連するデータ オフィスアクションに関するデータ（調査報告、審査結果（拒絶や特許査定等）、オフィスアクションに対する応答（補正や意見等）、関連する管理情報（出願期限や手数料支払い等）等） 通貨等の、手数料の支払いに関連するデータ 知財の分野に特有の用語や定義 |
| 機関 | APIを提供する機関によりフィルタリングします | 使用可能な機関1つ以上選択します。 |
| レスポンスの言語 | API が返すコンテンツの言語によりフィルタリングします | 使用可能な言語を1つ以上選択します。 |
| レスポンスの形式 | API が返すコンテンツのファイル形式によりAPIをフィルタリングします | 次のうち1つ以上を選択します:
|
| APIプロトコル | APIがRESTかSOAPかによりAPI をフィルタリングします | RESTまたはSOAPのいずれかを選択
|
| API Operations | APIを介して実行可能な操作によりAPI をフィルタリングします | 次のうち1つ以上を選択します:
|
連絡先
APIカタログについてご不明な点があれば、お問い合わせください。
ユーザの皆様のオンライン体験を向上させるために、クッキーおよびその他の識別子を使用しています。WIPOウェブサイトを利用することにより、これに同意したことになります。こちらで、データプライバシーに関する事項 の詳細を確認できます。