Documentation

The OMV Developer portal allows you to browse all APIs and API products published by OMV. The APIs and API products that will be visible to you are dependent on your assigned access policy (public, partner or internal developer). If you are not signed in you will only see public APIs and API products.

In the details page of every API you'll find all the documentation (ie. OpenAPI) for the APIs as specified in the OMV API Management gateway. You will also be able to test the API from this page. If you receive a 404 (not found) error when trying to test the API directly from the API details page it might be that this is an internal API, which is not reachable from this portal. In this case please connect to VPN and use a HTTP test client like Postman to test the API.

Products

API products are logical containers for OMV APIs that belong together in one domain. As a client developer you will have to request access to a whole API product. This will provide you with authorization to access all of the APIs covered under the given product.

Authorization

There are multiple forms of authorizations that an API can provide.

  • Oauth2

  • Client certificate

  • API subscription key (as additional header to identify the client or as a minimum identifier for public, non-confidential APIs)

You can request API subscription key(s) and/or an OAuth2 client from the product detail page. After requesting the key or the Oauth2 client the respective OMV API product owner(s) will receive an email and approve or reject your request. You will get notification emails on any update in this flow. As for your subscription keys, you can manage (view and regenerate) them under your Profile section. If the API only supports client certificate authentication please get in touch with the API product owner(s) directly. In case you need more information about how you can authenticate to a specific API please get in touch with the API product owner(s) or the HIP team by sending an email.

If you want to get more information about how to call an API with or without subscription key, then please go the given API specification page.

API Management instances

Within OMV there are three API management instances, each having a dedicated developer portal. It also means that you need to register separately in each developer portal if you want to request access to the respective APIs.

DEV

The DEV instance is used for mainly development purposes by the API maintainers. This environment is not intended to be used by clients because the APIs might be under continous development.

Base URL: https://api-dev.omv.com/

Developer portal URL: https://developer-dev.omv.com/

TEST

The TEST instance is used for testing purposes by both API maintainers and the clients of the APIs.

Base URL: https://api-test.omv.com/

Developer portal URL: https://developer-test.omv.com/

PROD

The PROD instance contains the productive APIs, and used by the clients of the APIs.

Base URL: https://api.omv.com/

Developer portal URL: https://developer.omv.com/