API-Katalog - Anleitung für IP-Einrichtungen

Sorgen Sie dafür, dass Ihre APIs einfach zu finden sind

In dieser Anleitung wird erläutert, wie IP-Einrichtungen ihre APIs über den API-Katalog für geistiges Eigentum bereitstellen können.

Der API-Katalog kann diese APIs auf der Grundlage der von den IP-Einrichtungen bereitgestellten OpenAPI-Spezifikationsdateien (OAS) automatisch erfassen. Befolgen Sie die nachstehenden Schritte, um sicherzustellen, dass Ihre APIs in den Katalog aufgenommen werden.

Anmerkung: Wenn Sie nicht in der Lage sind, eine OAS-Datei zu erstellen, füllen Sie bitte diese EXCEL-Vorlage mit den erforderlichen Angaben aus und senden Sie sie per E-Mail an uns..

1. Erstellen Sie eine OAS-Datei für Ihre API

Erstellen Sie zuerst eine OAS-Datei für Ihre API, die die folgenden wesentlichen Anforderungen erfüllt:

Version: Verwenden Sie OAS Version 3.0.x (3.0.0 wird empfohlen).
Vorlage: Verwenden Sie die bereitgestellte Vorlage (JSON, YAML) um sicherzustellen, dass Ihre OAS-Datei den Mindestanforderungen entspricht: (JSON Vorlage, YAML Vorlage).

Mindestanforderungen für die Datenstandards der OAS-Datei

In der nachstehenden Tabelle sind die Felder aufgeführt, die für Ihre OAS-Datei erforderlich sind.

Beachten Sie, dass nachstehend mit einem "x-" gekennzeichnete OAS-Erweiterungsfelder aufgeführt sind, die den Vorgaben der Open API Extensions Specifications von Swagger entsprechen.

Falls Sie keinen Wert für die definierten Felder in der Vorlage angeben können, bezeichnen Sie diese Felder im API-Katalog als "manuelle Eingabe". Künftige Aktualisierungen erfordern das Hinzufügen des Extension-Schemas zu Ihrer OAS-Datei, um manuelle Bearbeitungen zu vermeiden.

OAS-Feld	Datenart	Beschreibung
openapi:	String	Version der verwendeten Open-API-Spezifikation (es wird empfohlen, 3.0.x zu verwenden)
Info Object:
- title:	String	Name der API
- description:	String	Beschreibung der API (vorzugsweise in einem Format, das die Anwendungsfälle beschreibt, z. B. Diese API bietet Zugang zu [Funktionalität], damit die Nutzer [Aktionen] durchführen können)
- version:	String	Die Version Ihrer OAS-Datei für die API. Wir empfehlen die Verwendung des Formats 1.0.1
- x-oas-url:	String	Der URL-Link zu derjenigen Seite, von der die OAS-Datei heruntergeladen werden kann (so kann der automatische Scraper die Seite regelmäßig auf Aktualisierungen überprüfen, die Sie an der OAS-Datei vornehmen)
- x-product-page-url:	String	Der URL-Link zu derjenigen Produktseite, auf der die API auf Ihrer Website beschrieben ist (dadurch wird sichergestellt, dass die Nutzer des API-Katalogs direkt auf die gesuchte API verwiesen werden können)
- x-ip-domain	Array[String]	Führen Sie alle IP-Bereiche auf, die für diese API-Funktionalität relevant sind: Patente, Marken, gewerbliche Muster und Modelle, Urheberrecht, geografische Angaben, Sortenschutz, Layoutentwurf einer integrierten Schaltung
- x-service-type	Array[String]	Listen Sie alle Arten von Diensten auf, welche die API bereitstellen kann: Kontoverwaltung, Verwaltung von Anmeldungen, Kommunikation, Verbreitung, Zahlung, Portfolioverwaltung, Register, Suche, Übersetzung (siehe unten für detailliertere Beschreibungen für jeden dieser Diensttypen)
- x-content-type	Array[String]	Liste aller Arten von Inhalten, die die API bereitstellen kann: Zusammenfassung, bibliographische Daten, Zitierdaten, Ansprüche, Klassifikation, Gerichtsentscheide, Beschreibung, Familiendaten, Volltext, Angaben zum Rechtsstatus, Daten zur Lizenzvergabe, Daten zu Amtshandlungen, zahlungsbezogene Daten, Terminologiedaten (siehe unten für detailliertere Beschreibungen zu jeder Art von Inhalten)
- x-content-language	Array[String]	Auflistung aller Inhaltssprachen, in denen die API antworten kann, durch Kommata getrennt, im Format ISO 639-1 Set 1.
- contact	Contact Object
Contact Object:
- email	String	E-Mail des Teams, das für die API kontaktiert werden soll
- name	String	Name der Einrichtung
- URL	String	URL für die Startseite des API-Katalogs der Einrichtung oder des Entwicklerportals
Pfad-Objekt:	Path Item Object	Enthält die entsprechenden Pfade zu den einzelnen Endpunkten und ihren Operationen. Der Pfad wird an die URL aus dem Server-Objekt angehängt, um die vollständige URL zu erstellen
/(für jeden Pfad...)
- summary:	String	Eine Zusammenfassung, die für alle Vorgänge in diesem Pfad gelten soll
- get/put/post/delete		Eine Definition der GET/PUT/POST/DELETE-Operationen auf diesem Pfad
- responses	Responses Object
-- HTTP Status Code	Response Object
--- description	String	Eine Beschreibung der Antwort
--- content	Map [String, Media Type Object]	Format des Content-Type der Antwort, z. B. application/json oder application/pdf, usw.

2. Veröffentlichen Sie Ihre OAS-Datei

Veröffentlichen Sie Ihre OAS-Datei auf Ihrer Website mit einer statischen URL. Stellen Sie sicher, dass es keine zusätzlichen Hindernisse gibt, die das direkte Scraping Ihrer OAS-Spezifikation verhindern würden, zum Beispiel die Veröffentlichung der Spezifikation als ZIP-Datei.

Wichtig: Wenn Sie die OAS-URL oder die API-Produktseiten-URL nicht in Ihre ursprüngliche OAS-Datei aufnehmen konnten, denken Sie daran, Ihre OAS-Datei zu aktualisieren, indem Sie diese mit einem "x" gekennzeichneten OAS-Felder als neue Version veröffentlichen. Vergessen Sie nicht, die Version zu aktualisieren, um anzugeben, dass Sie diese Änderungen vorgenommen haben!

3. Teilen Sie dem Internationalen Büro die URL Ihrer OAS-Datei mit

Senden Sie die OAS-URL per E-Mail an das Internationale Büro der WIPO. Alle anderen erforderlichen Informationen werden automatisch anhand der Angaben in Ihrer OAS-Datei abgefragt.

4. Validieren Sie den neuen API-Eintrag, wenn Sie ihn erhalten

Nachdem Sie Schritt 3 abgeschlossen haben, erhalten Sie eine E-Mail mit den Details zu Ihrer API.

Wenn die erforderlichen Felder in der E-Mail nicht korrekt oder leer sind, ergänzen Sie die entsprechenden Daten in Ihrer OAS-Datei und veröffentlichen Sie sie nochmals, bevor Sie sie erneut an das Internationale Büro senden.

Anmerkung: Aktualisieren Sie Ihre OAS-Datei regelmäßig, um alle vorgeschlagenen Datenfelder einzubeziehen und eine "einzige Quelle der Wahrheit" zu erhalten. Dieses Vorgehen gewährleistet Konsistenz und reduziert den Bedarf an manuellen Aktualisierungen.

Verfügbare Filter für den API-Katalog

In der folgenden Tabelle sind die verfügbaren Filter zusammengefasst. Es können ein oder mehrere Filter gleichzeitig gesetzt werden.

Filter-Label	Funktion	Optionen
IP-Bereich	Filtert nach Art des Inhalts des geistigen Eigentums, das von der API zurückgegeben wird	Wählen Sie eine oder mehrere der folgenden Möglichkeiten: Patente Handelsmarken Gewerbliche Muster und Modelle Urheberrecht Geographische Angaben Sortenschutz Layoutentwurf einer elektronischen Schaltung
API-Dienst-Typ	Filtert nach Art der Dienstleistung oder Funktionalität, die von der API bereitgestellt wird	Wählen Sie eine oder mehrere der folgenden Möglichkeiten: Kontoführung Dienst für die Erstellung und Verwaltung des Benutzer-Kontos Verwaltung von Anmeldungen Dienst für die Einreichung von IP-Anmeldungen, einschließlich der Erstellung und Einreichung einer IP-Anmeldung. Kommunikation Kommunikation zwischen den Markenämtern und den betreffenden Inhabern, einschließlich Kommunikation mit Anmeldern oder deren Vertretern in Zusammenhang mit Amtshandlungen. Zum Beispiel für prüfungsrelevante oder gebührenbezogene Kommunikation. Verbreitung Verbreitung verschiedener Daten wie Veröffentlichung von IP-Anmeldungen, Daten zu Gerichtsentscheiden, Zusammenfassungen, Zitierdaten, Klassifikationsdaten, Volltextdaten usw. Zahlung Zahlungsdienste für verschiedene Gebühren wie Anmeldegebühren und Erneuerungsgebühren. Portfoliomanagement Dienste für die Verwaltung von IP-Portfolios durch die Schutzrechtsinhaber oder deren Vertreter. Register Dienste, die öffentlich verfügbare Informationen über IP-Anmeldungen einschließlich verfahrenstechnischer Details bereitstellen. Suche Dienst für das Abrufen von Informationen auf Grundlage von spezifischen Anfragen, wie Stichwortsuche oder die Suche nach Anmeldenummern. Übersetzung Dienst für die Übersetzung von IP-Dokumentation oder -Daten.
Inhaltstyp	Filtert nach Art des Inhalts, der von der API zurückgegeben wird	Wählen Sie eine oder mehrere der folgenden Möglichkeiten: Zusammenfassung Eine genaue Zusammenfassung des Inhalts des IP-Dokuments. Bibliographische Daten Die beschreibenden Informationen über das IP-Dokument. Dazu gehören der Titel, der Anmelder oder Rechtsnachfolger, das Datum der Anmeldung, Veröffentlichungsdaten und andere relevante administrative und verfahrenstechnische Details. Zitierdaten RVerweise durch ein Patentdokument auf frühere Patente (Patentzitierungen) oder Nichtpatentliteratur (NPL-Zitierungen). Ansprüche Der Umfang des Schutzes durch ein Patent, der die Reichweite der Abdeckung durch das Patent bestimmt. Klassifikation Die IP-Dokumente werden nach Themenbereichen in verschiedene Klassen und Unterklassen eingeteilt. Dazu gehören IPC/CPC für Patente, Nizza für Marken, Locarno für gewerbliche Muster und Modelle. Daten zu Gerichtsentscheiden Informationen und Details zu Rechtsentscheiden von Gerichtsfällen in Zusammenhang mit IP-Angelegenheiten. Beschreibung Eine genaue Erklärung der Erfindung. Familiendaten Eine Sammlung zusammenhängender IP-Dokumente, die von einer einzigen ursprünglichen Anmeldung stammen. Volltext Die vollständige, detaillierte Beschreibung der Erfindung oder Schöpfung in einer Patentanmeldung oder einem erteilten Patent. Angaben zum Rechtsstatus Der aktuelle rechtliche Status einer spezifischen IP-Anmeldung mit oder ohne den relevanten historischen rechtlichen Status für die IP-Anmeldung; oder das Datenset zu Ereignissen zum rechtlichen Status im betreffenden Zeitraum wie einer bestimmten Woche oder einem bestimmten Monat. Die Ämter sind dazu angehalten, die Informationen gemäß den WIPO-Standards ST.27, ST.61 oder ST.87 bereitzustellen. Daten zur Lizenzvergabe Daten betreffend die IP-Lizenzvergabe. Daten zu Amtshandlungen Daten zu Amtshandlungen wie Suchbericht, Prüfungsbericht (z. B. Zurückweisung oder Erteilung des Schutzes), Antworten zu Amtshandlungen (z. B. Änderung oder Argumentation) oder damit zusammenhängende administrative Informationen (z. B. Anmeldedatum oder Entrichtung von Gebühren). Zahlungsbezogene Daten Daten in Zusammenhang mit der Entrichtung der Gebühren, wie beispielsweise die Währung. Terminologiedaten Spezifische Begriffe und Definitionen, die im IP-Bereich verwendet werden.
Einrichtung	Filtert nach der Einrichtung, welche die API bereitstellt	Wählen Sie eine oder mehrere der verfügbaren Einrichtung.
Antwortsprache	Filtert nach der Sprache des Inhalts, der von der API zurückgegeben wird	Wählen Sie eine oder mehrere der verfügbaren Sprachen.
Antwortformat	Filtert nach dem Dateiformat des Inhalts, der von der API zurückgegeben wird	Wählen Sie eine oder mehrere der folgenden Möglichkeiten: JSON XML IMG (TIFF, PNG,...) PDF TXT DOCX Sound Multimedia 3D ZIP
API-Protokoll	Filtert danach, ob die API REST oder SOAP ist	Wählen Sie entweder REST oder SOAP REST SOAP
API-Operationen	Filtert nach Operationen, die über die API verfügbar sind	Wählen Sie eine oder mehrere der folgenden Möglichkeiten: GET PUT POST DELETE

Kontakte

Wenn Sie weitere Fragen zum API-Katalog haben, wenden Sie sich bitte an uns.

Wir verwenden Cookies und andere Identifikatoren, um Ihr Online-Erlebnis zu verbessern. Durch die Nutzung der WIPO-Website erklären Sie sich damit einverstanden. Erfahren Sie mehr über unseren Datenschutzhinweis.