Subscriptions

Documentation (English)

For the German version, please scroll down to “Dokumentation (Deutsch)”

What does a subscription mean in APIM Developer portal?

In the context of an API Management (APIM) developer portal, a subscription for a product refers to an arrangement where a client subscribes to any API as a “product” that groups together more APIs.

It allows DKV to provide access to the documentation of subscribed products and enables the Try It feature.

Once subscribed, the user receives a unique subscription key, which must be selected in the Try It feature to test API requests.

This key is part of the authorization process for making test API requests.

How to get the Subscription Key for the API access

The other kind of Subscription Key is generated by the DKV and you receive it by E-Mail along with other access credentials like client_id and client_secret.

How it Works:

The client sends the subscription key in the request header when making real (not a test) API call for retrieving his own data.

Header: ocp-apim-subscription-key

Value: 1234567890abcdef1234567890abcdef

The API server checks the subscription key to:

• Ensure that the client has access to the API.

• Enforce rate limits or usage quotas based on the subscription plan.

If the subscription key is missing or invalid, the server returns an error 401 Unauthorized.

{
    "code": 401,
    "errors": [
        {
            "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription.",
            "field": null
        }
    ]
}

Dokumentation (Deutsch)

Hier finden Sie die deutsche Dokumentation.

Abonnements (subscriptions)

Was bedeutet ein Abonnement im APIM-Entwicklerportal?

Im Kontext eines API-Management (APIM)-Entwicklerportals bezieht sich ein Abonnement für ein Produkt auf eine Vereinbarung, bei der sich ein Kunde auf eine Enterprise-API als „Produkt“ abonniert, das mehrere APIs gruppiert.

Dadurch kann DKV dem Kunden Zugriff auf die Dokumentation der abonnierten Produkte gewähren und die Nutzung der Try It-Funktion ermöglichen.

Sobald der Kunde abonniert ist, erhält er einen eindeutigen Abonnement-Schlüssel, der in der Try It-Funktion ausgewählt werden muss, um API-Anfragen zu testen.

Dieser Schlüssel ist Teil des Authentifizierungsprozesses für die Durchführung von Test-API -Anfragen.

Wie erhält man den Abonnement-Schlüssel für den API-Zugang?

Ein anderer Abonnement-Schlüssel wird von DKV generiert und Ihnen zusammen mit anderen Zugangsdaten wie client_id und client_secret per E-Mail zugeschickt.

How it Works:

Der Kunde sendet den Abonnement-Schlüssel im Header der Anfrage, wenn er eine echte (keine Test-) API-Anfrage zur Abfrage seiner eigenen Daten stellt.

Header: ocp-apim-subscription-key

Wert: 1234567890abcdef1234567890abcdef

Der API-Server prüft den Abonnement-Schlüssel, um:

• Sicherzustellen, dass der Kunde Zugang zur API hat.

• Nutzungsbegrenzungen oder Quoten gemäß dem Abonnementplan durchzusetzen.

Falls der Abonnement-Schlüssel fehlt oder ungültig ist, gibt der Server einen Fehler 401 Unauthorized zurück.

{
    "code": 401,
    "errors": [
        {
            "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription.",
            "field": null
        }
    ]
}