Ihre Vorteile auf einen Blick
|
|
|
|
|
Ressourcen sparen APIs ermöglichen die Automatisierung von Aufgaben und Prozessen. Das spart Zeit und steigert die Effizienz. |
Echtzeit-Zugriff Immer aktuelle Daten, die maßgeschneiderte Lösungen ermöglichen – genau abgestimmt auf spezifische Bedürfnisse. |
Sicherer Datenzugriff Skalierbarkeit von Diensten und Sicherheitsfunktionen wie Authentifizierung und Autorisierung. |
Integration Nahtlose Integration verschiedener Softwarelösungen sowie Zugriff auf Funktionen und Dienste von Drittanbietern. |
Das Nautos-Modul API Metadaten kurz erklärt
Die praktische Schnittstelle an der Nautos-Suche
Jederzeit adhoc Metadaten zu Normen abfragen.
Sie müssen regelmäßig sicherstellen, dass Ihre Produktionsprozesse den aktuellen Industriestandards und Normen entsprechen, um höchste Qualität und Compliance zu gewährleisten? Die Verweise in ihren Systemen sollen automatisiert überprüft und aktualisiert werden? Sie wollen manuelle und fehleranfällige Überprüfungen vermeiden?
Dann ist das Nautos-Modul API Metadaten für Sie die ideale Ergänzung Ihrer Normen-Management-Lösung. Das Modul ermöglicht es Ihnen, aus externen Anwendungen jederzeit auf die aktuellen Daten zuzugreifen und kundenspezifische Suchanfragen automatisiert an Nautos zu stellen.
Use Case:
Normeninformationen und Aktualitätsprüfung im Intranet
Hintergrund:
Für ein Unternehmen ist die Verwendung von aktuellen Normen und Richtlinien entscheidend, um sicherzustellen, dass alle Prozesse und Produkte dem geforderten Stand der Technik entsprechen. Eine zentrale Suchfunktion im Intranet, die über die Nautos-Suche auf die Metadaten von Normen zugreift, kann diesen Bedarf decken und die benötigten Normeninformationen direkt bereitstellen – eine sofortige Aktualitätsprüfung erfolgt.Ziel:
Implementierung einer Suchfunktion im Intranet, die es den Mitarbeitenden ermöglicht, nach Normeninformationen zu suchen und gleichzeitig die Aktualität der Normen zu prüfen.Beteiligte Rollen:
- Mitarbeitende: Recherche nach Normeninformationen
- IT-Team/externer Dienstleister: Verantwortlich für die Implementierung und Wartung der API sowie der Suchfunktion im Intranet.
- Zuständige für Normen-Management (Nautos, Metadaten, etc.): Verantwortlich für die Beschaffung und Koordination in Zusammenarbeit mit DIN Media.
Ablauf:
- Suchanfrage starten:
Mitarbeitende geben in das Suchfeld des Intranets eine Suchanfrage ein, z. B. die Dokumentennummer einer Norm oder einen Suchbegriff.- API-Anfrage senden:
Die Suchanfrage wird an die API Metadaten (…/api/v1/search/) gesendet.
Beispielhafter API-Call:- Ergebnisse erhalten:
Die API liefert die Suchergebnisse im JSON-Format, welche alle relevanten Metadaten zu den Normen enthalten, einschließlich des Aktualitätsstatus.
Beispielhaftes JSON-Ergebnis (gekürzte Darstellung):- Ergebnisse anzeigen:
Die Suchergebnisse werden im Intranet angezeigt, die wichtigsten Metadaten hervorgehoben, bspw. Dokumentennummer, Titel, Status der Aktualität, Ausgabedatum und ggf. die Norm, die eine andere ersetzt hat.
Die Benutzeroberfläche könnte eine tabellarische Ansicht oder eine Liste mit Navigationsfunktion durch die Suchergebnisse sein.- Aktualitätsprüfung:
Neben jeder Norm wird der Status der Aktualität angezeigt (z. B. „Current", „Historical"). Falls eine Norm als „Historical" zurückgezogen markiert ist, wird zusätzlich ein Hinweis angezeigt, welche nachfolgende Norm (ggf. mehrere Normen) diese ersetzt hat.
Beispielhafte Darstellung im Intranet (gekürzte Darstellung):
Document Number
Issue Date
Status
Title
Replaced by
ISO 9001
2015-09
Current
Quality management systems - Requirements
ISO 14001
2004-11
Historical
Environmental management systems - Requirements with guidance for use
ISO 14001 (2015-09)
Fazit: Die Implementierung einer Intranet-Suchfunktion, um Normen-Inhalte mithilfe des Nautos-Moduls API Metadaten adhoc bereitzustellen, ermöglicht es Unternehmen, stets die aktuellen Normen zu verwenden und damit die Einhaltung von Compliance-Vorgaben zu gewährleisten. Risiken im Zusammenhang mit veralteten Normen werden reduziert. Das Nautos-Modul API Metadaten steigert zudem die Effizienz.
Mit dem Nautos-Modul API Metadaten kann Ihr Unternehmen seine Prozesse optimieren, die Produktqualität sicherstellen und gleichzeitig Zeit und Kosten sparen:
FAQ für das Nautos-Modul API Metadaten
-
Nach erfolgreicher Authentifizierung können individuelle Abfragen mit den benötigten Nautos-Datenfeldern konfiguriert werden. Je nach Konfiguration erhält man die Metadatensätze und deren Datenfelder in der gewünschten Sortierung zurück. Die detaillierten Feldbezeichnungen und Parameter für den Aufruf erhalten Sie in einer zusätzlichen Dokumentation.
-
Sie erhalten einen kundenspezifischen Zugriff auf Nautos-Metadaten per API an einen definierten Endpunkt (/api/v1/search/). Die Abfrage aller Metadaten der Nautos-Suche ist adhoc möglich – abgesehen von in Nautos angelegten Firmendatensätzen. Die Ergebnisse können Sie gemäß der Konfiguration Ihrer Anfrage (Paging, Sortierung, Offset) dynamisch in Ihr System übernehmen.
Beispiel-Request:
<searchRequest>
<query>TitleDe:testmethoden</query>
<offset>0</offset>
<maxCount>10</maxCount>
<sorts>
<sort>
<field>AcCode</field>
<direction>asc</direction>
</sort>
</sorts>
<resultFields>
<resultField>AcCode</resultField>
<resultField>TitleDe</resultField>
<resultField>AbstractDe</resultField>
<resultField>Author</resultField>
<resultField>DescriptorDe</resultField>
</resultFields>
</searchRequest>
Der Request liefert im Ergebnis die Treffer und Felder in der definierten Reihenfolge: (Auszug):
-
Für die Nutzung der API benötigen Sie ein Tool, das POST-Requests ausführen kann, sowie die Fähigkeit, die erhaltenen Daten zu verarbeiten und in Ihre bestehenden Systeme zu integrieren. Eine stabile Internetverbindung ist ebenfalls erforderlich.
-
Die API nutzt einen Token-basierten Authentifizierungsmechanismus. Nach der Registrierung erhalten Sie einen API-Schlüssel, der in jeder Anfrage mitgesendet werden muss, um Zugang zu den Metadaten zu erhalten.
-
Ja, bei bestimmten Metatenfeldern wie bspw. „Titel" sind mehrere Sprachen vorhanden. Weitere Informationen zum Umfang der Metadaten erhalten Sie vom Team Vertrieb Normen-Management-Lösungen.
-
Die technische Einbindung der API liegt in der Verantwortung des Kunden. Der Endpunkt für das Modul wird ohne Oberfläche ausgeliefert, zur Ausführung der Abfragen ist ein entsprechendes Tool zur Absendung eines POST-Requests notwendig.
DIN Media stellt eine Dokumentation sowie Support bei Fehlern bereit. Ein Hilfevideo zur Verwendung eines Tools zur Absendung eines POST-Requests ist in der Nautos-Hilfe verfügbar.
-
Ja, die API ist so konzipiert, dass sie leicht in bestehende Anwendungen und Systeme integriert werden kann. Sie können die Ergebnisse der API-Abfragen dynamisch in Ihre Prozesse und Workflows übernehmen.
-
Die Sicherheit Ihrer Daten hat für uns höchste Priorität. Alle Datenübertragungen erfolgen verschlüsselt über HTTPS. Zudem setzen wir moderne Authentifizierungs- und Autorisierungsmechanismen ein, um unbefugten Zugriff zu verhindern.
-
Um die Serviceleistung zu gewährleisten behält sich DIN Media vor, die Frequenz der Requests sowie den Umfang zu begrenzen. Details dazu finden Sie in der Dokumentation und in den Nutzungsbedingungen.
-
Ja, um die Serviceleistung zu gewährleisten, kann es Einschränkungen bei der Datenmenge und der Anzahl der Anfragen geben. Details dazu finden Sie in der Dokumentation und den Nutzungsbedingungen.
-
Voraussetzung für die Nutzung des Nautos-Moduls API Metadaten ist der Erwerb der Normen-Management-Lösung Nautos.
Da die API Metadaten auf alle Metadatenfelder und Regelwerke zugreift, muss die Lizenzierung des Moduls und der Metadaten auf den Umfang der Nutzung im Zielsystem erfolgen.
Wir beraten Sie gerne.
-
Wir bieten Kunden technischen Support per E-Mail und Telefon an. Zudem stellen wir eine umfassende Dokumentation, Videos und Hilfetexte zur Verfügung, die Ihnen bei der Implementierung und Nutzung der API helfen.
-
Videos und Hilfetexte zu Ihrer Unterstützung sind in der Nautos-Hilfe verfügbar. Bei spezifischen Fragen steht das Team Vertrieb Normen-Management per E-Mail unter normenmanagement@dinmedia.de oder telefonisch unter +49 30 58885700-50 zur Verfügung.