Normas - ST.90 Página: 3.90.1
Total Page:16
File Type:pdf, Size:1020Kb
MANUAL DE INFORMACIÓN Y DOCUMENTACIÓN EN MATERIA DE PROPIEDAD INDUSTRIAL Ref.: Normas - ST.90 página: 3.90.1 NORMA ST. 90 RECOMENDACIONES PARA EL TRATAMIENTO Y LA COMUNICACIÓN DE DATOS DE PROPIEDAD INTELECTUAL MEDIANTE INTERFACES DE PROGRAMACIÓN DE APLICACIONES (API) PARA SERVICIOS WEB Adoptada por el Comité de Normas Técnicas de la OMPI (CWS) en su octava sesión, celebrada el 4 de diciembre de 2020 Índice INTRODUCCIÓN ............................................................................................................................................................ 3 DEFINICIONES Y TERMINOLOGÍA .............................................................................................................................. 3 NOTACIONES ................................................................................................................................................................ 4 Notaciones generales ....................................................................................................................................................... 4 Identificadores de normas ................................................................................................................................................ 4 GRADO DE APLICACIÓN .............................................................................................................................................. 5 PRINCIPIOS DE DISEÑO DE UNA API PARA SERVICIOS WEB ................................................................................ 6 API WEB RESTFUL........................................................................................................................................................ 7 Componentes de los URI.................................................................................................................................................. 7 Códigos de estado ............................................................................................................................................................ 9 Principio de selección cuidadosa ..................................................................................................................................... 9 Modelo de recursos .......................................................................................................................................................... 9 Compatibilidad con múltiples formatos ........................................................................................................................... 12 Métodos HTTP ................................................................................................................................................................ 12 Patrones de consulta de datos ....................................................................................................................................... 18 Control de errores ........................................................................................................................................................... 24 Contrato de servicio ........................................................................................................................................................ 26 Tiempo de espera ........................................................................................................................................................... 27 Control del estado ........................................................................................................................................................... 27 Gestión de preferencias .................................................................................................................................................. 29 Traducción ...................................................................................................................................................................... 29 Operaciones de larga duración ...................................................................................................................................... 29 Modelo de seguridad ...................................................................................................................................................... 30 Modelo de madurez de la API ........................................................................................................................................ 35 API WEB SOAP ............................................................................................................................................................ 36 Normas generales .......................................................................................................................................................... 36 Esquemas ...................................................................................................................................................................... 37 Nombres y versiones ...................................................................................................................................................... 37 Diseño del contrato de servicio web ............................................................................................................................... 38 Adhesión de políticas a las definiciones WSDL ............................................................................................................. 38 SOAP - Seguridad de servicios web .............................................................................................................................. 39 FORMATOS DE TIPOS DE DATOS ............................................................................................................................ 39 es / 03-90-01 Fecha: diciembre de 2020 MANUAL DE INFORMACIÓN Y DOCUMENTACIÓN EN MATERIA DE PROPIEDAD INDUSTRIAL Ref.: Normas - ST.90 página: 3.90.2 CONFORMIDAD ........................................................................................................................................................... 40 MATERIAL DE REFERENCIA ...................................................................................................................................... 41 Normas de la OMPI ........................................................................................................................................................ 41 Normas y convenciones ................................................................................................................................................. 41 API REST de las oficinas de PI ...................................................................................................................................... 43 API REST de empresas y directrices de diseño ............................................................................................................ 43 Otros ...................................................................................................................................................................... 43 ANEXOS ANEXO I - LISTA DE NORMAS DE DISEÑO Y CONVENCIONES DE SERVICIOS WEB RESTFUL ANEXO II - VOCABULARIO DE PI RELATIVO A LA ARQUITECTURA REST ANEXO III - DIRECTRICES DE LAS API WEB RESTFUL Y MODELO DE CONTRATO DE SERVICIO ANEXO IV - MEJORES PRÁCTICAS DE ARQUITECTURA DE SEGURIDAD DE ALTO NIVEL ANEXO V - CÓDIGOS DE ESTADO HTTP ANEXO VI - TÉRMINOS DE REPRESENTACIÓN ANEXO VII - PUBLICACIÓN DE LA GESTIÓN DEL CICLO DE VIDA DE LAS API es / 03-90-01 Fecha: diciembre de 2020 MANUAL DE INFORMACIÓN Y DOCUMENTACIÓN EN MATERIA DE PROPIEDAD INDUSTRIAL Ref.: Normas - ST.90 página: 3.90.3 INTRODUCCIÓN 1. En la presente norma se formulan recomendaciones sobre las interfaces de programación de aplicaciones (API) para facilitar el tratamiento y el intercambio de datos de propiedad intelectual (datos de PI) de manera armonizada a través de Internet. 2. La norma tiene como finalidad: garantizar la coherencia mediante el establecimiento de principios uniformes de diseño de servicios web; mejorar la interoperabilidad de los datos entre los socios de servicios web; fomentar la reutilización a través de un diseño unificado; promover la flexibilidad en la asignación de nombres a los datos en todas las unidades operativas por medio de una política de espacio de nombres claramente definida en los recursos de lenguaje extensible de marcado (XML) asociados; promover un intercambio de información seguro; ofrecer procesos operativos internos apropiados como servicios de valor añadido que puedan ser utilizados por otras organizaciones; e integrar sus procesos operativos internos y vincularlos dinámicamente con sus asociados institucionales. DEFINICIONES Y TERMINOLOGÍA 3. A efectos de lo previsto en la presente norma: se entenderá por "protocolo de transferencia de hipertexto (HTTP)" un protocolo de aplicación para sistemas de información distribuidos, colaborativos e hipermedia. HTTP es la base de la comunicación de datos para la World Wide Web (WWW), y funciona como un protocolo de petición-respuesta en el modelo de computación orientado al servicio; se entenderá por "interfaz de programación de aplicaciones (API)" un conjunto de componentes de software que proporcionan una interfaz reutilizable entre diferentes aplicaciones que pueden comunicarse fácilmente para intercambiar datos; se entenderá por "transferencia de estado representacional (REST)" un conjunto de principios de arquitectura en virtud