Guide du Catalogue des API à l'intention des institutions de propriété intellectuelle
Faciliter la découverte de vos API
Ce guide explique comment les institutions de propriété intellectuelle peuvent fournir leurs API par l’intermédiaire du Catalogue des API en matière de propriété intellectuelle.
Le Catalogue des API peut automatiquement enregistrer ces API à partir des fichiers de spécification OpenAPI (OAS) fournis par les institutions de propriété intellectuelle. En suivant les étapes ci-dessous, vous pouvez vous assurer que vos API figurent dans le catalogue.
Note : Si vous n’êtes pas en mesure de produire un fichier OAS, veuillez remplir ce modèle EXCEL avec les renseignements nécessaires et nous l’envoyer par courrier électronique.
1. Créez un fichier OAS pour votre API
Pour commencer, créez un fichier OAS pour votre API en respectant les principales exigences suivantes :
- Version : Utilisez la version 3.0.x de l’OAS (la version 3.0.0 est recommandée).
- Modèle : Utilisez le modèle fourni (JSON, YAML) pour vous assurer que votre fichier OAS répond aux exigences minimales : (modèle JSON, modèle YAML).
Normes minimales relatives aux données pour le fichier OAS
Le tableau ci-dessous présente les champs obligatoires pour votre dossier OAS.
Notez qu’il existe des champs OAS d’extension indiqués ci-dessous par un “ x- ”, conformément aux indications fournies par les spécifications d’extension OpenAPI de Swagger.
Si vous ne pouvez pas fournir de valeur pour les champs définis dans le modèle, précisez alors dans le Catalogue des API que ces champs seront “remplis manuellement". Les prochaines mises à jour nécessiteront l’ajout du schéma d’extension à votre fichier OAS afin d’éviter les modifications manuelles.
| Champ OAS | Type de Données | Description |
|---|---|---|
| openapi: | String | Version de la spécification OpenAPI utilisée (il est recommandé d’utiliser la version 3.0.x) |
| Info Object : | ||
| - title: | String | Nom de l’API |
| - description: | String | Description de l’API (de préférence dans un format décrivant les cas d’utilisation, par exemple : “Cette API permet d’accéder à [fonctionnalité] afin que les utilisateurs puissent [actions]”). |
| - version: | String | La version de votre fichier OAS pour l’API. Nous recommandons d’utiliser le format 1.0.1 |
| - x-oas-url: | String | Le lien URL vers la page où le fichier OAS pourra être téléchargé (cela permet au système de recherche automatisé de vérifier régulièrement la page pour détecter toute mise à jour du fichier OAS) |
| - x-product-page-url: | String | Le lien URL vers la page du produit où l’API est décrite sur votre site Web (cela garantit que les utilisateurs du Catalogue des API peuvent être dirigés directement vers l’API qu’ils recherchent) |
| - x-ip-domain | Array[String] | Énumère tous les domaines de propriété intellectuelle pertinents pour cette fonctionnalité de l’API : brevets, marques, dessins et modèles industriels, droit d’auteur, indications géographiques, protection des obtentions végétales, conception de schémas de configuration de circuits intégrés |
| - x-service-type | Array[String] | Énumère tous les types de services que l’API peut fournir : gestion de compte, gestion d’application, communication, diffusion, paiement, gestion de portefeuille, registre, recherche, traduction (voir ci-dessous pour des descriptions plus détaillées de chacun de ces types de services) |
| - x-content-type | Array[String] | Énumère tous les types de contenu que l’API peut fournir : abrégé, données bibliographiques, données de citation, revendications, classification, décision de justice, description, données relatives aux familles, texte intégral, données relatives à la situation juridique, données relatives aux licences, données relatives aux actes des offices, données relatives aux paiements, données relatives à la terminologie (voir ci-dessous pour des descriptions plus détaillées de chacun de ces types de contenu) |
| - x-content-language | Array[String] | Énumère toutes les langues de contenu dans lesquelles l’API peut répondre, séparées par des virgules, au format ISO 639-1, série 1. |
| - contact | Contact Object | |
| Contact Object : | ||
| String | Adresse électronique de l’équipe à contacter concernant l’API | |
| - name | String | Nom de l’institution |
| - URL | String | URL de la page d’accueil du site de l’institution ou du portail des développeurs |
| Paths Object : | Path Item Object | Indique les chemins d’accès correspondants aux différents points de terminaison et à leurs opérations. Le chemin d’accès est ajouté à l’URL du Server Object afin de construire l’URL complet |
| /(pour chaque chemin d’accès...) | ||
| - summary: | String | Résumé sous forme de chaîne, destiné à s’appliquer à toutes les opérations dans ce chemin d’accès |
| - get/put/post/delete | Définition des opérations GET/PUT/POST/DELETE sur ce chemin d’accès | |
| - responses | Responses Object | |
| -- HTTP Status Code | Response Object | |
| --- description | String | Description de la réponse |
| --- content | Map [String, Media Type Object] | Format de la réponse du type de contenu, par exemple application/json ou application/pdf, etc. |
2. Publiez votre fichier OAS
Publiez votre fichier OAS sur votre site Web à l’aide d’une URL statique. Assurez-vous également qu’il n’y a pas d’autres inhibiteurs qui empêcheraient la recherche directe de votre spécification OAS. Par exemple, publiez la spécification sous la forme d’un fichier ZIP.
Important : Si vous n’avez pas pu inclure l’URL de l’OAS ou l’URL de la page de produit de l’API dans votre fichier OAS initial, n’oubliez pas de mettre à jour votre fichier OAS avec les champs OAS ci-dessus indiqués par un “x” et de le republier en tant que nouvelle version. N’oubliez pas de mettre à jour la version pour indiquer que vous avez effectué ces changements!
3. Communiquez l’URL de votre fichier OAS au Bureau international
Envoyez l’URL de l’OAS au Bureau international de l’OMPI par courrier électronique. Les autres renseignements requis seront automatiquement recherchés à l’aide des détails fournis dans votre fichier OAS.
4. Validez la nouvelle entrée API lorsque vous la recevrez
Lorsque vous aurez terminé l’étape 3 ci-dessus, vous recevrez un message électronique contenant les détails de votre API.
Dans ce message électronique, si les champs obligatoires sont incorrects ou vides, ajoutez les données pertinentes à votre fichier OAS et republiez-le avant de le renvoyer au Bureau international.
Note : Mettez régulièrement à jour votre dossier OAS en y incluant tous les champs de données suggérés afin de conserver une “source unique de vérité”. Cela garantit la cohérence et réduit le besoin de mises à jour manuelles.
Filtres disponibles pour le Catalogue des API
Le tableau ci-après présente une synthèse des filtres disponibles. Un ou plusieurs filtres peuvent être définis en même temps.
| Nom du filtre | Fonction | Options |
| Domaine de propriété intellectuelle | Filtre le type de contenu de propriété intellectuelle renvoyé par l’API |
Choisissez une ou plusieurs options parmi les suivantes :
|
| Type de services API | Filtre le type de service ou de fonctionnalité fourni par l’API |
Choisissez une ou plusieurs options parmi les suivantes : Service de création et de gestion de compte d’utilisateur. Service pour le dépôt d’une demande de droit de propriété intellectuelle, y compris la création d’une demande de droit de propriété intellectuelle et sa présentation. Les communications entre les offices de propriété intellectuelle et les titulaires de droits de propriété intellectuelle concernés, y compris les communications concernant les actions de l’office, telles que les communications relatives à l’examen ou aux taxes, adressées aux déposants ou à leurs mandataires. Diffusion de diverses données telles que la publication des demandes de droits de propriété intellectuelle, les données relatives à la situation juridique, les données relatives aux décisions de justice, les abrégés, les données de citation, les données de classification, les données en texte intégral... Services de paiement de diverses taxes telles que les taxes de dépôt et de renouvellement. Services de gestion de portefeuille de propriété intellectuelle par les titulaires des droits de propriété intellectuelle ou leurs mandataires. Services fournissant des informations accessibles au public sur les demandes de droits de propriété intellectuelle, y compris les informations sur la procédure. Service permettant de rechercher des informations à l’aide de requêtes spécifiques, comme la recherche par mot-clé ou par numéro de demande. Service de traduction de la documentation ou des données relatives à la propriété intellectuelle. |
| Type de contenu | Filtre les API par type de contenu renvoyé par l’API |
Choisissez une ou plusieurs options parmi les suivantes : Résumé concis du contenu du document de propriété intellectuelle. Informations descriptives concernant le document de propriété intellectuelle. Elles incluent généralement le titre, le déposant ou le cessionnaire, la date de dépôt, les dates de publication et d’autres informations administratives et de procédure pertinentes. Renvois d’un document de brevet à des brevets antérieurs (citations de brevet) ou à la littérature non-brevet. L’étendue de la protection conférée par un brevet, qui détermine la portée du brevet. Les documents de propriété intellectuelle sont classés dans différentes classes et sous-classes en fonction de leur objet. Cela inclut la CIB/CPC pour les brevets, Nice pour les marques, Locarno pour les dessins et modèles industriels. Informations et précisions sur les décisions de justice rendues dans le cadre de procédures judiciaires portant sur des questions de propriété intellectuelle. Explication détaillée de l’invention. Collection de documents de propriété intellectuelle connexes issus d’un seul dépôt initial. Description complète et détaillée de l’invention ou de la création dans une demande de brevet ou un brevet délivré. La situation juridique actuelle d’une demande de droit de propriété intellectuelle spécifique, avec ou sans les événements historiques relatifs à la situation juridique de la demande; ou l’ensemble des données relatives aux événements relatifs à la situation juridique des demandes de droits de propriété intellectuelle survenus au cours d’une période donnée, telle qu’une semaine ou un mois donné. Les offices sont encouragés à fournir les informations conformément aux normes ST.27, ST.61 ou ST.87 de l’OMPI. Données relatives à la concession de licences de propriété intellectuelle. Les données relatives aux actes de l’office, comme le rapport de recherche, le résultat de l’examen (par exemple, rejet ou décision d’octroi), les réponses aux actes de l’office (par exemple, modification ou justification), ou les informations administratives connexes (par exemple, date d’échéance de la demande ou paiement de la taxe). Les données relatives au paiement des taxes, comme la devise. Termes et définitions spécifiques utilisés dans le domaine de la propriété intellectuelle. |
| Institution | Filtre selon l’institution fournissant l’API | Choisissez une ou plusieurs des Institutions disponibles. |
| Langue de la réponse | Filtre selon la langue du contenu renvoyé par l’API | Choisissez une ou plusieurs des langues disponibles. |
| Format de la réponse | Filtre les API selon le format de fichier du contenu renvoyé par l’API |
Choisissez une ou plusieurs options parmi les suivantes :
|
| Protocole des API | Filtre les API selon qu’il s’agit d’une API REST ou SOAP |
Choisissez REST ou SOAP
|
| Opérations des API | Filtre les API selon les opérations disponibles par l’intermédiaire de l’API |
Choisissez une ou plusieurs options parmi les suivantes :
|
Contact
Si vous avez d’autres questions concernant le Catalogue des API, veuillez nous contacter.
Nous utilisons des cookies et d’autres identifiants pour améliorer votre navigation en ligne. En utilisant le site Web de l’OMPI, vous acceptez ce principe. En savoir plus sur notre Avis relatif à la protection des données personnelles.