Manual del catálogo de API para instituciones de PI
Facilitar el acceso a sus API
En esta guía se explica cómo las instituciones de PI pueden proporcionar sus API a través del catálogo de API para la propiedad intelectual.
El catálogo de API puede recopilar automáticamente esas API a partir de los archivos de especificaciones OpenAPI (OAS) proporcionados por las instituciones de PI. A continuación se indican los pasos para incluir las API en el catálogo.
Nota: Si no puede crear un fichero OAS, rellene esta plantilla EXCEL con los datos necesarios y envíenosla por correo electrónico.
1. Cree un archivo OAS para su API
Para empezar, cree un archivo OAS para su API que cumpla los siguientes requisitos:
- Versión: Utilice la versión 3.0.x de OAS (se recomienda la 3.0.0).
- Plantilla: Utilice la plantilla proporcionada (JSON, YAML) para que el archivo OAS cumpla los requisitos mínimos: (plantilla JSON, plantilla YAML).
Normas mínimas de datos para el archivo OAS
En el cuadro siguiente figura el mínimo de campos necesarios para el archivo OAS.
Tenga en cuenta que a continuación se indican con una “x-” los campos OAS de extensión conforme a las especificaciones sobre extensiones para OpenAPI de Swagger.
Si no puede proporcionar un valor para los campos definidos desde la plantilla, especifique esos campos como "entrada manual" en el catálogo de API. En el futuro será necesario añadir el esquema de extensiones al archivo OAS para evitar la edición manual.
Campo OAS | Tipo de datos | Descripción |
---|---|---|
openapi: | String | Versión de la especificación Open API utilizada (se recomienda utilizar la versión 3.0.x) |
Info Object: | ||
- title: | String | Nombre de la API |
- description: | String | Descripción de la API (preferiblemente en un formato en el que se describan su uso; p. ej.: Esta API proporciona acceso a [función] para [acción]) |
- version: | String | La versión del archivo OAS para la API. Recomendamos utilizar el formato 1.0.1 |
- x-oas-url: | String | El enlace URL a la página en la que el archivo OAS estará disponible para su descarga (permite al rastreador comprobar regularmente las posibles actualizaciones del archivo OAS) |
- x-product-page-url: | String | El enlace URL a la página del producto donde se describe la API en el sitio web (permite que los usuarios del catálogo de API puedan ser remitidos directamente a la API que están buscando) |
- x-ip-domain | Array[String] | Mostrar todos los ámbitos de PI pertinentes para esta función de la API: patentes, marcas, diseños industriales, derechos de autor, indicaciones geográficas, protección de las obtenciones vegetales, diseño de circuitos integrados |
- x-service-type | Array[String] | Mostrar todos los servicios que puede proporcionar la API: gestión de cuentas, gestión de aplicaciones, comunicación, difusión, pago, gestión de cartera, registro, búsqueda, traducción (a continuación encontrará descripciones más detalladas de cada uno de esos servicios) |
- x-content-type | Array[String] | Mostrar todo el contenido que puede proporcionar la API: resumen, datos bibliográficos, datos de citas, reivindicaciones, clasificación, decisión judicial, descripción, datos de la familia, texto completo, datos de la situación jurídica, datos de licencias, datos de trámites de la oficina, datos relacionados con los pagos, datos terminológicos (a continuación encontrará descripciones más detalladas de cada uno de esos tipos de contenido). |
- x-content-language | Array[String] | Mostrar todos los idiomas en los que la API puede responder, separados por comas, en formato ISO 639-1 conjunto 1. |
- contact | Contact Object | |
Contact Object: | ||
String | Correo electrónico del equipo con el que ponerse en contacto sobre la API | |
- name | String | Nombre de la institución |
- URL | String | URL de la página de inicio del sitio del catálogo de API de la institución o del portal para desarrolladores |
Objeto de ruta: | Path Item Object | Contiene las rutas relativas a los extremos individuales y sus operaciones. La ruta se añade a la URL del objeto servidor para construir la URL completa |
/(para cada ruta...) | ||
- summary: | String | Cadena de resumen destinada a aplicarse a todas las operaciones de esta ruta |
- get/put/post/delete | Definición de las operaciones GET/PUT/POST/DELETE en esta ruta | |
- responses | Responses Object | |
-- HTTP Status Code | Response Object | |
--- description | String | Descripción de la respuesta |
--- content | Map [String, Media Type Object] | Formato del tipo de contenido de la respuesta, por ejemplo, application/json o application/pdf, etc. |
2. Publique el archivo OAS
Publique el archivo OAS en su sitio web con una URL estática. Asegúrese también de que no hay inhibidores adicionales que impidan el rastreo directo de su especificación OAS. Por ejemplo, la publicación de la especificación como archivo ZIP.
Importante: Si no pudo incluir la URL OAS o la URL de la página del producto API en el archivo OAS inicial, recuerde actualizar el archivo OAS con los campos OAS indicados anteriormente con una “x” y vuelva a publicarlo como una nueva versión. No olvide actualizar la versión para indicar que ha realizado esos cambios.
3. Comparta la URL del archivo OAS con la Oficina Internacional
Envíe por correo electrónico la URL OAS a la Oficina Internacional de la OMPI. El resto de la información necesaria se obtendrá automáticamente a partir de los datos que figuran en el archivo OAS.
4. Valide la nueva entrada de la API cuando la reciba
Una vez realizado el paso 3, recibirá un correo electrónico con los datos de la API.
En el correo electrónico, si los campos obligatorios son incorrectos o están en blanco, añada los datos pertinentes al archivo OAS y vuelva a publicarlo antes de reenviarlo a la Oficina Internacional.
Nota: Actualice regularmente el archivo OAS para incluir todos los campos de datos sugeridos y mantener así una única fuente de datos. Ello garantiza la coherencia y reduce la necesidad de actualizaciones manuales.
Filtros disponibles para el catálogo de API
En el cuadro siguiente se resumen los filtros disponibles. Se pueden definir uno o varios filtros al mismo tiempo.
Etiqueta del filtro | Función | Opciones |
Ámbito de PI | Filtra el tipo de contenido de propiedad intelectual que devuelve la API | Elija una o varias de las siguientes opciones:
|
Tipo de servicio de la API | Filtra el tipo de servicio o función que ofrece la API | Elija una o varias de las siguientes opciones: Servicio de creación y mantenimiento de cuentas de usuario. Servicio de presentación de solicitudes de PI, incluida su creación. Comunicaciones entre las oficinas de PI y los titulares de PI, incluidas las comunicaciones los solicitantes o sus representantes acerca de los trámites de la oficina, por ejemplo, en relación con el examen o las tasas. Difusión de datos sobre la publicación de solicitudes de PI, la situación jurídica, las resoluciones judiciales, los resúmenes, las citas, la clasificación o el texto completo. Servicios de pago de diversas tasas, por ejemplo, de presentación o renovación. Servicios para la gestión de la cartera de PI por parte de los titulares de derechos de PI o sus representantes. Servicios que proporcionan información de acceso público sobre solicitudes de PI, incluidos los datos del procedimiento. Servicio de obtención de información a partir de consultas específicas, como la búsqueda por palabras clave o por número de solicitud. Servicio de traducción de documentación o datos sobre PI. |
Tipo de contenido | Filtra las API por el tipo de contenido devuelto por la API | Elija una o varias de las siguientes opciones: Resumen conciso del contenido del documento de PI. Información descriptiva sobre el documento de PI. Suele incluir el título, el solicitante o cesionario, la fecha de presentación, las fechas de publicación y otros datos administrativos y de procedimiento. Referencias hechas por un documento de patente a patentes anteriores (citas de patentes) o a documentación no relacionada con patentes. El alcance de la protección concedida por una patente, que determina la extensión de la cobertura de la patente. Los documentos de PI se clasifican en diferentes clases y subclases en función de la materia. Incluye la CIP/CPC para patentes, Niza para marcas y Locarno para diseños industriales. Información y detalles sobre las resoluciones judiciales relacionadas con la PI. Explicación detallada de la invención. Conjunto de documentos de PI que tienen su origen en una misma solicitud. Descripción completa y detallada de la invención o creación en una solicitud de patente o una patente concedida. La situación jurídica de una solicitud de PI específica con o sin el historial de estados correspondientes; o bien los datos de los estados relativos a la situación jurídica de las solicitudes de PI ocurridos durante un período de tiempo determinado, como una semana o un mes. Se recomienda a las oficinas que faciliten la información siguiendo las normas ST.27, ST.61 o ST.87 de la OMPI. Datos relacionados con la concesión de licencias de PI. Los datos relacionados con los trámites de la oficina, como el informe de búsqueda, el resultado del examen (por ejemplo, el rechazo o la decisión de concesión), las respuestas a los trámites de la oficina (por ejemplo, la modificación o la argumentación) o la información administrativa pertinente (por ejemplo, la fecha de vencimiento de la solicitud o el pago de tasas). Los datos relacionados con el pago de tasas, como la divisa. Términos y definiciones específicos utilizados en el ámbito de la PI. |
Institución | Filtra por la institución que proporciona la API | Elija una o varias de las Instituciones disponibles. |
Lengua de respuesta | Filtra por el idioma del contenido que devuelve la API | Elija uno o varios de los idiomas disponibles. |
Formato de la respuesta | Filtra las API por el formato de archivo del contenido que devuelve la API | Elija una o varias de las siguientes opciones:
|
Protocolo API | Filtra las API en función de si son REST o SOAP | Elija REST o SOAP
|
Operaciones de las API | Filtra las API por las operaciones que ofrecen | Elija una o varias de las siguientes opciones:
|
Contacto
Si tiene alguna duda sobre el catálogo de API, póngase en contacto con nosotros.
Utilizamos cookies y otros identificadores para facilitar su experiencia en línea. Al utilizar el sitio web de la OMPI, usted acepta lo anterior. Más información sobre nuestra declaración de confidencialidad de datos.