Guia do Catálogo de APIs para Instituições de PI

Facilitando a descoberta das suas APIs

Este guia explica como as instituições de PI podem disponibilizar suas APIs por meio do Catálogo de APIs de Propriedade Intelectual.

O Catálogo de APIs pode capturar automaticamente essas APIs com base nos arquivos OpenAPI Specification (OAS) fornecidos pelas instituições de PI. Seguindo as etapas abaixo, você pode garantir que suas APIs sejam incluídas no Catálogo.

Observação: Se você não for capaz de produzir um arquivo OAS, preencha este modelo EXCEL com os detalhes necessários e envie-nos por e-mail.

1. Crie um arquivo OAS para sua API

Para começar, crie um arquivo OAS para sua API que atenda aos seguintes requisitos principais:

Versão: Use o OAS versão 3.0.x (recomenda-se a versão 3.0.0).
Modelo: Utilize o modelo fornecido (JSON, YAML) para garantir que seu arquivo OAS cumpre os requisitos mínimos: (modelo JSON, modelo YAML).

Padrões de dados mínimos para o arquivo OAS

A tabela abaixo relaciona os conjuntos mínimos de campos necessários para seu arquivo OAS.

Observe que há campos de extensão OAS fornecidos abaixo, indicados com um “x-“, seguindo a orientação fornecida pelas especificações das extensões Open API do Swagger.

Se você não puder fornecer um valor para os campos definidos no modelo, especifique esses campos para “entrada manual” no Catálogo de API. As atualizações futuras exigirão que o esquema de extensão seja adicionado ao seu arquivo OAS para evitar edições manuais.

Campo OAS	Tipo de dados	Descrição
openapi:	String	Versão da especificação Open API usada (recomenda-se usar a versão 3.0.x)
Info Object:
- title:	String	Nome da API
- description:	String	Descrição da API (de preferência em um formato que descreva os casos de uso; por exemplo: esta API fornece acesso a [funcionalidade] para que os usuários possam [ações])
- version:	String	A versão do seu arquivo OAS para a API. Recomendamos usar o formato 1.0.1
- x-oas-url:	String	O link para o URL da página onde o arquivo OAS estará disponível para download (isso permite que o extrator (scraper) automatizado verifique regularmente a página para detectar eventuais atualizações que você faça no arquivo OAS)
- x-product-page-url:	String	O link para o URL da página do produto onde a API é descrita no seu site (isso garante que os usuários do Catálogo de APIs possam ser encaminhados diretamente para a API que estão procurando)
- x-ip-domain	Array[String]	Liste todas as áreas de domínio de IP relevantes para essa funcionalidade de API: patente, marca, desenho industrial, direitos de autor, indicação geográfica, proteção de obtenções vegetais, topografia de circuito integrado
- x-service-type	Array[String]	Liste todos os tipos de serviços que a API pode fornecer: gerenciamento de conta, gerenciamento de depósito de pedido, comunicação, divulgação, pagamento, gestão de portfólio, registro, pesquisa, tradução (veja abaixo descrições mais detalhadas de cada um desses tipos de serviço)
- x-content-type	Array[String]	Liste todos os tipos de conteúdo que a API pode fornecer: resumo, dados bibliográficos, dados de citação, reivindicações, classificação, decisão judicial, descrição, dados de família, texto completo, dados de situação jurídica, dados de licenciamento, dados de ações do instituto, dados relacionados a pagamentos, dados terminológicos (veja abaixo descrições mais detalhadas de cada um desses tipos de conteúdo)
- x-content-language	Array[String]	Liste todos os idiomas de conteúdo em que a API pode responder, separados por vírgulas, no formato ISO 639-1 conjunto 1.
- contact	Contact Object
Contact Object:
- email	String	E-mail da equipe de contato da API
- name	String	Nome da instituição
- URL	String	URL da página inicial do site do Catálogo da APIs da instituição ou do portal do desenvolvedor
Paths Object:	Path Item Object	Contém os caminhos relativos para os pontos de extremidade individuais e suas operações. O caminho é anexado ao URL do objeto do servidor para construir o URL completo
/(para cada caminho...)
- summary:	String	Uma string de resumo para ser aplicada a todas as operações nesse caminho
- get/put/post/delete		Uma definição das operações GET/PUT/POST/DELETE nesse caminho
- responses	Responses Object
-- HTTP Status Code	Response Object
--- description	String	Uma descrição da resposta
--- content	Map [String, Media Type Object]	Formato da resposta de tipo de conteúdo – por exemplo, application/json ou application/pdf, etc.

2. Publique seu arquivo OAS

Publique seu arquivo OAS em seu site com um URL estático. Certifique-se também de que não haja inibidores adicionais que impeçam a extração direta da sua especificação OAS. Por exemplo, publicar a especificação como um arquivo ZIP.

Importante: Se você não conseguiu incluir o URL do OAS ou da página do produto da API no seu arquivo OAS inicial, lembre-se de atualizar seu arquivo OAS com os campos OAS indicados com um “x” acima e republicar como uma nova versão. Não se esqueça de atualizar a versão para indicar que você fez essas alterações!

3. Compartilhe o URL do seu arquivo OAS com a Secretaria Internacional

Envie o URL do OAS por e-mail para a Secretaria Internacional da OMPI. Todas as outras informações necessárias serão extraídas automaticamente usando os detalhes fornecidos no seu arquivo OAS.

4. Valide a nova entrada da API quando recebê-la

Depois de concluir a Etapa 3 acima, você receberá um e-mail com os detalhes da sua API.

No e-mail, se os campos obrigatórios estiverem incorretos ou em branco, adicione os dados relevantes ao seu arquivo OEA e publique-o novamente antes de reenviá-lo para a Secretaria Internacional.

Observação: Atualize regularmente seu arquivo OAS para incluir todos os campos de dados sugeridos de modo a manter uma "única fonte de verdade". Isso garante a consistência e reduz a necessidade de atualizações manuais.

Filtros disponíveis no Catálogo de APIs

A tabela a seguir resume os filtros disponíveis. Um ou mais filtros podem ser definidos ao mesmo tempo.

Rótulo do filtro	Função	Opções
Domínio de PI	Filtra o tipo de conteúdo de propriedade intelectual que é retornado pela API	Escolha uma ou mais das seguintes opções: Patente Marca Desenho industrial Direito de autor Indicação geográfica Proteção de obtenções vegetais Topografia de circuito integrado
Tipo de serviço da API	Filtra o tipo de serviço ou funcionalidade que a API fornece	Escolha uma ou mais das seguintes opções: Gerenciamento de conta Serviço para criação e manutenção de conta de usuário. Gerenciamento de depósito de pedido Serviço para depósito de um pedido de PI, incluindo a criação de um pedido de PI e seu envio. Comunicação Comunicações entre os institutos de PI e os titulares de PI, incluindo as relacionadas a ações do instituto, como aquelas ligadas aos requerentes ou seus representantes para, por exemplo, questões relacionadas a exames ou taxas. Divulgação Divulgação de vários tipos de dados, como publicação de pedidos de PI, dados de situação jurídica, dados de decisões judiciais, resumos, dados de citação, dados de classificação, dados de texto completo, etc. Pagamento Serviços de pagamento de diversas taxas, como as taxas de depósito e de renovação. Gestão de portfólio Serviços de gestão de portfólio de PI pelos titulares/detentores de direitos de PI ou seus representantes. Registro Serviços de fornecimento de informações públicas sobre depósitos de pedidos de PI, incluindo detalhes de tramitação. Busca Serviço para recuperação de informações com base em consultas específicas, como pesquisas por palavras-chave ou por número do pedido. Tradução Serviço para tradução de documentos ou dados de PI.
Tipo de conteúdo	Filtra pelo tipo de conteúdo de que é retornado pela API	Escolha uma ou mais das seguintes opções: Resumo Um resumo conciso do conteúdo do documento de PI. Dados bibliográficos Informações descritivas sobre o documento de PI. Geralmente incluem o título, o requerente ou cessionário, a data de depósito, as datas de publicação e outros detalhes administrativos e processuais relevantes. Dados de citação Referências feitas por um documento de patente a patentes anteriores (citações de patente) ou à literatura não patentária (citações à literatura não patentária). Reivindicações O escopo da proteção concedida por uma patente, determinando a extensão da cobertura da patente. Classificação Os documentos de PI são categorizados em diferentes classes e subclasses com base em seu assunto. Essas categorias incluem IPC/CPC para patentes, Nice para marcas e Locarno para desenhos industriais. Dados de decisões judiciais Informações e detalhes sobre decisões proferidas em processos judiciais envolvendo questões de PI. Descrição Uma explicação detalhada da invenção. Dados de família Uma coleção de documentos de PI relacionados que são originários de um único depósito inicial. Texto completo Descrição completa e detalhada da invenção ou criação em um pedido de patente ou patente concedida. Dados de situação jurídica A situação jurídica atual de um pedido de PI específico, com ou sem o histórico de eventos relevantes relativos à situação jurídica do pedido de PI; ou o conjunto de dados de eventos relativos à situação jurídica de pedidos de PI ocorridos durante um período de tempo específico, como uma determinada semana ou mês. Recomenda-se aos institutos que forneçam as informações seguindo as Normas da OMPI ST.27, ST.61 ou ST.87. Dados de licenciamento Dados relativos ao licenciamento de PI. Dados de ações do instituto Dados relacionados às ações do instituto, como relatórios de pesquisa, resultados de exame (por exemplo, decisão de indeferimento ou deferimento), respostas às ações do instituto (por exemplo, alteração ou argumentação) ou informações administrativas relacionadas (por exemplo, data de vencimento do pedido ou pagamento de taxa). Dados relacionados a pagamento Dados relacionados ao pagamento de taxas, como a moeda. Dados terminológicos Termos e definições específicos utilizados na área de PI.
Instituição	Filtra pela instituição fornecedora da API	Escolha uma ou mais dos instituições disponíveis.
Idioma da resposta	Filtra pelo idioma do conteúdo que a API retorna	Escolha um ou mais dos idiomas disponíveis.
Formato da resposta	Filtra pelo formato de arquivo do conteúdo que a API retorna	Escolha uma ou mais das seguintes opções: JSON XML IMG (TIFF, PNG...) PDF TXT DOCX Áudio Multimídia 3D ZIP
Protocolo da API	Filtra por API REST ou SOAP	Escolha REST ou SOAP REST SOAP
Operações da API	Filtra pelas operações disponíveis na API	Escolha uma ou mais das seguintes opções: GET PUT POST DELETE

Contatos

Se tiver dúvidas adicionais sobre o Catálogo de APIs, entre em contato conosco.

Usamos cookies e outros identificadores para ajudar a melhorar sua experiência online. Ao utilizar o site da OMPI, você concorda com isso. Saiba mais sobre nosso Aviso sobre a proteção de dados pessoais.