Nautos API Metadata Module

Query metadata on standards ad hoc at any time in the Nautos search.

  • Customer-specific access to metadata via an API (Application Programming Interface).
  • Direct query of all metadata fields from external applications.
  • Results provided according to the configuration of the query.

Benefits at a glance

Save resources
APIs enable the automation of tasks and processes. That saves time and enhances efficiency.

Real-time access
Always up-to-date data that enables customized solutions - precisely tailored to specific needs.

Secure data access
Scalability of services and security functions such as authentication and authorization.

Integration
Seamless integration of various software solutions and access to third-party functions and services.

Nautos API Metadata Module in brief

The practical interface to Nautos searching

Query metadata on standards ad hoc at any time.

Do you need to regularly ensure that your production processes meet current industry standards to guarantee the highest quality and compliance? Do you want the references in your systems to be automatically checked and updated? Do you want to avoid manual and error-prone checks?

Then the Nautos API Metadata Module is the ideal addition to your standards management solution. The module enables you to access the current data from external applications at any time and to automatically submit customer-specific search queries to Nautos. 

Use Case: 

Standards information and update check in the intranet

Background:

The use of current standards and guidelines is crucial for a company to ensure that all processes and products comply with the required state of the art. A central search function in the intranet, which accesses the metadata of standards via the Nautos search, can meet this need and provide the required standards information directly - with an immediate update check.

The goal:  

Implementation of a search function in the intranet that enables employees to search for standards information and at the same time check that the standards are up to date.  

Who’s involved?

  1. Employees: Search for standards information
  2. IT team/external service provider: Responsible for the implementation and maintenance of the API and the search function in the intranet. 
  3. Person(s) responsible for standards management (Nautos, metadata, etc.): Responsible for procurement and coordination in cooperation with DIN Media. 

How it works: 

  1. Start a search query: 
    Employees enter a search query in the intranet search field, e.g. the document number of a standard or a search term.  
  2. Send an API request
    The search query is sent to the API metadata (.../api/v1/search/). 
    Example of an API call:  
  3. Get the results
    The API delivers the search results in JSON format, which contain all relevant metadata on the standards, including the current status. 
    Example of a JSON result (abbreviated): 
  4. Display results: 
    The search results are displayed in the intranet, with the most important metadata highlighted, e.g. document number, title, current status, issue date and, if applicable, the standard that has replaced another.
    The user interface could be a tabular view or a list with a navigation function through the search results. 
  5. Update check: 
    The current status is displayed next to each standard (e.g. "Current", "Historical"). If a standard is marked as "Historical" (i.e. withdrawn more than a month ago), a note is also displayed indicating which subsequent standard (possibly several standards) has replaced it.
    Example of how it is shown in the intranet (abbreviated): 

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) 

Summary: The implementation of an intranet search function to provide standards content ad hoc using the Nautos API Metadata Module helps companies to always use the latest standards and thus ensure compliance. Risks associated with outdated standards are reduced. The Nautos API Metadata Module also increases efficiency.

With the Nautos API Metadata Module, your company can optimize its processes, ensure product quality and save time and costs at the same time:

  • Time savings thanks to automated queries and the seamless integration of various software solutions - the effort required for manual searches is significantly reduced.
  • Up-to-date metadata ensures that production processes always comply with the latest standards.
  • Direct integration into existing systems improves the efficiency and accuracy of data processing.
  • Quick and easy adaptation of production processes to current standards increases compliance and minimizes the risk of production errors.

FAQ Nautos API Metadata Module

  • After successful authentication, individual queries can be configured with the required Nautos data fields. Depending on the configuration, the metadata records and their data fields are returned in the desired order. The detailed field names and parameters for the request can be found in additional documentation.

  • You receive customized access to Nautos metadata via API to a defined endpoint (/api/v1/search/). All metadata of the Nautos search can be queried ad hoc - except for company records created in Nautos. You can dynamically transfer the results to your system according to the configuration of your query (paging, sorting, offset).

    Example of a 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>


    The request returns the hits and fields in the defined order: (extract):

  • To use the API, you need a tool that can execute POST requests and the ability to process the data received and integrate it into your existing systems. A stable internet connection is also required.

  • The API uses a token-based authentication mechanism. After registration, you will receive an API key that must be sent with every request in order to gain access to the metadata.

  • Yes, several languages are available for certain metadata fields such as "Title". For more information on the scope of the metadata, please contact the Standards Management Solutions Sales team.

  • The technical integration of the API is the responsibility of the customer. The endpoint for the module is delivered without an interface; a corresponding tool for sending a POST request is required to execute the queries.

    DIN Media provides documentation and support in the event of errors. A help video on how to use a tool to send a POST request is available in the Nautos Help section.

  • Yes, the API is designed so that it can be easily integrated into existing applications and systems. You can dynamically incorporate the results of the API queries into your processes and workflows.

  • The security of your data is our top priority. All data transmissions are encrypted via HTTPS. We also use modern authentication and authorization mechanisms to prevent unauthorized access.

  • In order to guarantee our service, DIN Media reserves the right to limit the frequency and scope of requests. Details can be found in the documentation and in the Terms of Use.

  • Yes, in order to guarantee the service, there may be restrictions on the amount of data and the number of requests. Details can be found in the documentation and in the Terms of Use.

  • A prerequisite for using the Nautos API Metadata Module is the purchase of the Nautos standards management solution.

    Because the Metadata API accesses all metadata fields and document collections, the module and metadata must be licenced to the extent of use in the target system.

    We will be happy to consult you in this.

  • We offer customers technical support by e-mail and telephone. We also provide comprehensive documentation, videos and help texts to help you implement and use the API.

  • Videos and help texts to support you are available in the Nautos Help section. For specific questions, the Standards Management Sales team can be contacted by e-mail at  normenmanagement@dinmedia.de or by telephone at +49 30 58885700-50.