Руководство по использованию Каталога API для учреждений ИС
Сделайте так, чтобы ваши API было легко найти
Данное руководство содержит информацию о том, как учреждения ИС могут предоставить доступ к своим API через Каталог API для интеллектуальной собственности.
Каталог API может автоматически собирать эти API при условии предоставления учреждениями ИС файлов спецификации OpenAPI (OAS). Для того чтобы ваши API были включены в Каталог, следуйте приведенной ниже инструкции.
Примечание. Если вы не можете предоставить файл OAS, укажите необходимую информацию в этом шаблоне Excel и отправьте его нам по электронной почте.
1. Создайте файл OAS для вашего API
Для начала создайте файл OAS для вашего API, который отвечает следующим ключевым требованиям.
- Версия: используйте версию OAS 3.0.x (рекомендуемая версия — 3.0.0).
- Шаблон: используйте предлагаемый шаблон (JSON, YAML), чтобы ваш файл OAS соответствовал минимальным требованиям (шаблон JSON, шаблон YAML).
Минимальные стандарты данных для файла OAS
В приведенной ниже таблице указан минимальный набор полей, требуемый для вашего файла OAS.
Обратите внимание на то, что ниже есть поля расширения OAS с символом «x-» в соответствии с рекомендациями Swagger по спецификациям для расширений Open API.
Если вы не можете предоставить значение для определенных полей из шаблона, то отметьте эти поля в Каталоге API как поля для «ручного ввода». При обновлении в будущем потребуется добавить схему расширения для вашего файла OAS, чтобы избежать правок вручную.
| Поле OAS | Тип данных | Описание |
|---|---|---|
| openapi: | String | Версия использованной спецификации Open API (рекомендуется использовать версию 3.0.x) |
| Info Object: | ||
| - title: | String | Название API |
| - description: | String | Описание API (желательно в формате, который описывает случаи использования, например, «Данный API предоставляет доступ к [перечисление функций], чтобы пользователи могли [перечисление действий]»). |
| - version: | String | Версия вашего файла OAS для API. Мы рекомендуем использовать формат 1.0.1. |
| - x-oas-url: | String | URL-ссылка на страницу, с которой можно будет скачать файл OAS (это позволит автоматическому алгоритму извлечения данных регулярно проверять страницу на наличие обновлений, которые вы вносите в файл OAS). |
| - x-product-page-url: | String | URL-ссылка на страницу продукта с описанием API на вашем веб-сайте (так пользователи Каталога API смогут напрямую обратиться к API, который они ищут). |
| - x-ip-domain | Array[String] | Перечень всех областей ИС, которые затрагивают функции этого API: патенты, товарные знаки, промышленные образцы, авторское право, географические указания, охрана сортов растений, топология интегральных микросхем. |
| - x-service-type | Array[String] | Перечень всех видов услуг, к которым API может предоставить доступ: управление учетной записью, управление заявкой, обмен сообщениями, распространение, оплата, управление портфелем, регистрация, поиск, перевод (ниже приведено более подробное описание каждого вида услуг). |
| - x-content-type | Array[String] | Перечень всех видов информации, которые может предоставить API: реферат, библиографические данные, данные о цитировании, формулы изобретения, классификация, судебные решения, описание, данные о патентных семействах, полный текст, данные о правовом статусе, данные о лицензировании, данные о решении ведомства, данные об оплате, терминологические данные (ниже приведено более подробное описание каждого вида информации). |
| - x-content-language | Array[String] | Перечень всех языков, на которых через API можно получить ответ, через запятую в формате ISO 639-1 (двухбуквенный код). |
| - contact | Contact Object | |
| Contact Object: | ||
| String | Адрес электронной почты группы, с которой можно связаться по вопросам, касающимся API. | |
| - name | String | Название учреждения. |
| - URL | String | URL-ссылка на главную страницу о Каталоге API учреждения или на портал разработчика. |
| Объект paths | Path Item Object | Хранит относительные пути доступа к отдельным конечным точкам и их операциям. Путь добавляется в конец адреса URL из серверного объекта для создания полного URL. |
| /(для каждого объекта 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
Опубликуйте свой файл OAS на вашем веб-сайте со статическим URL. Убедитесь также, что отсутствуют дополнительные препятствия, которые помешают прямому извлечению вашей спецификации OAS. Например, спецификация не должна быть опубликована в файле ZIP.
Важно! Если вы не смогли включить URL OAS или URL страницы продукта API в первоначальный файл OAS, не забудьте обновить свой файл OAS, добавив поля OAS, которые были обозначены выше символом «x», и опубликовать его как новую версию. Обязательно обновите номер версии, чтобы указать на то, что были внесены эти изменения!
3. Поделитесь вашим URL для файла OAS с Международным бюро
Отправьте электронное письмо с URL-ссылкой на файл OAS в Международное бюро ВОИС. Вся другая необходимая информация будет автоматически извлечена из данных, содержащихся в вашем файле OAS.
4. Подтвердите новую запись об API после ее получения по электронной почте
После выполнения третьего шага, описанного выше, вы получите электронное письмо с подробной информацией о вашем API.
Если в полученном письме требуемые поля заполнены неверно или остались пустыми, добавьте нужные данные в ваш файл OAS, снова опубликуйте его и повторно отправьте в Международное бюро.
Примечание. Регулярно обновляйте свой файл OAS и заполняйте все предлагаемые поля с данными, чтобы поддерживать «единый источник достоверных данных». Это позволяет обеспечить согласованность и снижает необходимость внесения обновлений вручную.
Доступные фильтры для Каталога API
В следующей таблице приводится краткое описание доступных фильтров. Можно применять один или несколько фильтров одновременно.
| Название группы фильтров | Функция | Варианты |
| Область ИС | Фильтры по виду информации об интеллектуальной собственности, который можно получить при помощи API | Выберите один или несколько видов ИС.
|
| Вид услуги API | Фильтры по виду услуги или функциям, которые позволяет осуществить API | Выберите одну или несколько услуг. Услуга по созданию и поддержанию учетной записи пользователя. Услуга по подаче заявки на регистрацию ИС, включая составление заявки на регистрацию ИС и ее подачу. Обмен сообщениями между ведомствами ИС и соответствующими владельцами ИС, например, заявителями или их представителями, в том числе в отношении действий ведомств, таких как сообщения, касающиеся экспертизы или пошлин. Распространение различных данных, например, публикация заявки на регистрацию ИС, данных о правовом статусе, данных о судебных решениях, реферата, данных о цитировании, данных о классификации, полнотекстовых данных... Услуги, касающиеся оплаты различных пошлин, например, пошлин за подачу заявки или за продление. Услуги по управления портфелем ИС для владельцев прав ИС/правообладателей или их представителей. Услуги, касающиеся предоставления публично доступной информации о заявках на регистрацию ИС, включая подробную информацию о процедуре. Услуга по извлечению информации на основе конкретных запросов, например, поиска по ключевым словам или поиска по номеру заявки. Услуги по переводу документации или данных, касающихся ИС. |
| Вид информации | Фильтры API по виду информации, который можно получить при помощи API | Выберите одну или несколько категорий. Краткое резюме содержимого документа об ИС. Описательная информация о документе об ИС. Обычно включает название, указание заявителя или патентообладателя, дату подачи заявки, даты публикации и другую соответствующую информацию об административных моментах и процедуре. Используемые в патентном документе ссылки на предыдущие патенты (цитирование патентов) или непатентную литературу (цитирование непатентной литературы). Объем предоставляемой патентом охраны, определяющий сферу действия патента. Документы об ИС разделяются на различные классы и подклассы по объекту. Они включают МПК/СПК для патентов, Ниццкую классификацию для товарных знаков, Локарнскую классификацию для промышленных образцов. Информация и подробности о решениях, вынесенных по итогам судебных разбирательств, затрагивающих вопросы ИС. Подробное описание изобретения. Подборка связанных документов об ИС, которые берут начало из одной первоначальной заявки на регистрацию. Полное и подробное описание изобретения или результата творческой деятельности в патентной заявке или в выданном патенте. Текущий правовой статус конкретной заявки на регистрацию ИС с или без истории изменений правового статуса этой заявки; или наборы данных об изменениях правового статуса заявки на регистрацию ИС, которые происходили в заданный период времени, например, на определенной неделе или в определенном месяце. Ведомствам рекомендуется представлять информацию в соответствии со стандартами ВОИС ST.27, ST.61 и ST.87. Данные, касающиеся лицензирования ИС. Данные о действиях ведомств, связанные, в частности, с отчетом о поиске, результатами экспертизы (например, об отклонении заявки и решении о выдаче патента), ответами на действия ведомств (например, внесение поправок или аргументация) или касающиеся административной информации (например, срок подачи заявки или оплата пошлины). Данные, касающиеся оплаты пошлин, такие как валюта. Конкретные термины и определения, используемые в этой области ИС. |
| Учреждение | Фильтры по учреждению, которое предоставляет API | Выберите одно или несколько доступных учреждений. |
| Язык ответа | Фильтры по языку, на котором API позволяет извлекать информацию | Выберите один или несколько доступных языков. |
| Формат ответа | Фильтры API по формату файла содержимого, которое выдает API | Выберите один или несколько.
|
| Протокол API | Фильтры API в зависимости от протокола (REST или SOAP) | Выберите REST или SOAP
|
| Операции API | Фильтры API по доступной операции через API | Выберите одну или несколько.
|
Контакты
Если у вас остались какие-либо вопросы о Каталоге API, свяжитесь с нами.
Мы используем файлы cookie и другие идентификаторы для повышения удобства вашей работы с сайтом. Вы соглашаетесь с их применением, если используете веб-сайт ВОИС. Более подробная информация содержится в уведомлении о конфиденциальности данных.