Skip to content

First Steps

Tenant Contact Data

Tenant contact details must first be provided in the "Set Tenant Contact" endpoint when starting to use the API.

Warning

This data is required for creating an OAID or a customer site.

About the Required Information

The PATCH method contains 2 fields ("contact" and "reference_url"), which are explained in detail in the following subsections.

Contact

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

The key-value pairs to provide within the "contact" object 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. Specific data associated with an OAID may be retrieved from this URL.

Any combination of the following data can be 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 query parameters and/or path 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"