Basic Principles

Once the access credentials have been transmitted and the API has been activated for the term of the agreement, new OAIDs can be created and existing ones can be managed.

Creation

An OAID can be generated using the API call for creation. With the subsequent confirmation, the receipt of the OAID is acknowledged by the client, and it is enabled for further use.

Creation and Confirmation

When the OAID is created, it will be assigned to the tenant.
Only after confirming the OAID will it be activated it for further use!

Shown below is the example workflow for the creation and subsequent confirmation of one or more OAIDs. The implementation may differ from this process in detail.

Before implementation, the deployment and use of OAID should be clarified within the tenant (see blue section in the above diagram). Only the tenant's existing processes and systems, as well as the planned usage, are relevant here. Once these (internal) requirements have been clarified, the development of the API client can begin. The necessary interactions with the OAID register, especially REQUEST (create OAID) and CONFIRM (confirm OAID), are described in the API documentation.

Processing OAID

Processing of the OAID (blue task) refers to the internal storage of the OAID.
This does not refer to, for example, the creation of the customer site, which can take several days or months.

Management

Attributes of the OAID can be updated through the API. The implementation for this can be found in the Update section.

Further usage is subject to OFAA standardizations and will be added here on an ongoing basis.