Premium API

Über die Premium-API kann manuelles Premium aktiviert werden. Außerdem kann Premium auch unmittelbar storniert werden.

Aktivieren der API

Die API kann jederzeit durch den Support aktiviert werden. Weitere Einstellmöglichkeiten und Informationen zu Sicherheitseinstellungen werden dann im Portalmanagement unter Einstellungen > API angezeigt.

Manuelles Premium aktivieren (POST)

https://PORTAL-DOMÄNE/api/premium/v1/activate/ENTRY_ID

Hier kann manuelles Premium für einen Eintrag aktiviert werden. Es wird ein beliebiges Paket zugewiesen bzw. das Standard-Premium-Produkt des Eintragstyps des Eintrags mit der übergebenen ID.

Im Body werden keine weiteren Informationen benötigt, für konkrete Anwendungsfälle könnten wir das jedoch erweitern, falls ein konkretes Paket oder individuelle Konditionen benötigt werden.

Zurückgegeben werden im Erfolgsfall die Basisinformationen des Eintrags zusammen mit weiteren Informationen zur Premium-Subscription:

{
    "BasicInfo": {
        "Id": 265584,
        "ModifiedDate": "2022-03-08T16:52:35",
        "CreatedDate": "2022-03-08T16:44:57",
        ...
    },
    "SubscriptionInfo": {
        "Status": "Manuell",
        "PlanName": "Premium PLUS",
        "Verified": true,
        "Price": "2.099,00 € (zzgl. USt.)",
        "LengthOfCurrentSubscriptionInMonths": 12,
        "BookingDate": "09.03.2022",
        "CurrentPeriodEndDate": "09.03.2023",
        "IsTestPremium": true
    },
    "Errors": []
}

Wenn es Probleme gibt, werden diese im Fehler-Array aufgelistet. Konkret könnte z. B. der Eintrag mit der ID bereits eine aktuelle Buchung besitzen.

Mehr Informationen gibt es auf der Seite API-Fehlermeldungen.

Aktuelle Premium-Buchung deaktivieren (POST)

https://PORTAL-DOMÄNE/api/premium/v1/cancel/ENTRY_ID

Hier kann Premium mit sofortiger Wirkung deaktiviert werden. Dabei ist es unerheblich, ob es sich um eine manuelle Buchung, eine Test-Buchung oder eine Buchung durch das Unternehmen selbst handelt.

Die Funktionalität ist identisch mit der Möglichkeit für den Portalbetreiber, im Portalmanagement Premium sofort zu stornieren.

Auch hier werden Basisinformationen des Eintrags zurückgegeben zusammen mit den Informationen zur aktuellen Buchung (die natürlich nach Dekativierung leer sein sollte):

{
    "BasicInfo": {
        "Id": 265584,
        "ModifiedDate": "2022-03-08T16:52:35",
        "CreatedDate": "2022-03-08T16:44:57",
        ...
    },
    "SubscriptionInfo": null,
    "Errors": []
}