Skip to content

Introduction

The central OAID Register is a platform accessible through an application programming interface (API). Special emphasis has been placed on supporting a wide range of companies with diverse requirements and systems. The API strictly adheres to the OpenAPI standard, enabling easy integration.

Actions on the API typically refer to just ONE (1) Open Access ID, allowing for both individual transactions and bulk processing.

By using modern and established technologies (OpenAPI, JSON, HTTPS, ...), as well as comprehensive documentation, seamless integration is guaranteed. A local integrator or IT service provider can use the API with little effort. Previous experience has shown that the challenges lie not in utilizing the central register but rather in integrating and automating locally specific processes.

Prerequisite: Tenant Contact Data

Tenant contact details must first be provided in the "Set Tenant Contact" endpoint when starting to use the API. This data is required for creating an OAID or a customer site.

This endpoint contains 2 parameters (contact and reference_url) and is explained in detail in the following subsections.

About the Parameters

Contact

The contact parameter stores the tenant's data accessible to the internet service provider (ISP). All contact information should be general business contacts (no personal contacts).

The fields should include:

  • company_name: The full company name
  • rtr_agg_id: The operator code from the RTR. Search company name in the RTR directory and locate this number under "Betreiber Code"
  • phone: The general business line
  • email_to: A general business info email address

Reference URL

The reference_url serves as a "callback URL" or a dynamically generated link to the tenant's own web portal, where specific data associated with an OAID may be retrieved.

Any combination of the following data can be called/received upon link access:

  • {oaid}: The open access ID
  • {customer_reference}: The tenant's unique customer reference ID
  • {tenant}: The tenant's company name or acronym

Each data field to be called upon clicking on the URL must be specified within the reference URL path as parameters. An example reference URL is:

https://link-to-me.at/{tenant}/{oaid}/?ref={customer_reference}

Not ready to utilize this feature yet?

No problem. In the meantime, please just set the reference_url to the company's homepage. The URL can be updated later.

Where to Submit

Endpoint: "Set Tenant Contact"