Lizenzen programmgesteuert mit der Licensing API verwalten

Erfahre, wie du die SecureMailMerge Lizenz-REST-API nutzt, um Lizenzen mit API-Schlüsseln programmatisch zu vergeben und zu entziehen.

Der Lizenzserver stellt eine REST API bereit, mit der Du Lizenzen programmgesteuert zuweisen und entziehen kannst. Das ist nützlich für Wiederverkäufer, die mehrere Kunden verwalten, IT-Teams, die das Onboarding automatisieren, oder für alle, die die Lizenzverwaltung in ihre eigenen Tools integrieren möchten.

Authentifizierung und Basis-URL

Alle API-Anfragen werden mit einem API-Schlüssel authentifiziert. Der API-Schlüssel ist eine GUID, die du im Request-Body (nicht im Header) angibst.

Alle API-Endpunkte sind verfügbar unter:

https://licensing.solinventum.com/api/manage/{subscriptionType}/{subscriptionID}

Wo:

• subscriptionType ist einer von: Paddle, Azure oder Manual
• subscriptionID ist die GUID deines Abonnements

Du musst diese URL nicht selbst zusammenstellen. Gehe auf dem Lizenzserver zur Seite “Assign Licenses” deines Abonnements und wähle den Tab Assign licenses via API. Dort wird die vollständige Basis-URL, dein API-Schlüssel und eine einsatzbereite JSON-Nutzlast für dein Abonnement angezeigt.

Deinen API-Schlüssel neu generieren

Wenn dein API-Schlüssel kompromittiert wurde, kannst du ihn auf derselben Seite neu generieren. Der alte Schlüssel wird sofort ungültig. Nur der Besitzer des Abonnements kann API-Schlüssel neu generieren. Verwende immer HTTPS beim Aufrufen der API und halte deinen API-Schlüssel geheim, jeder mit deinem API-Schlüssel kann Lizenzen in deinem Abonnement zuweisen und entfernen.

Lizenzen zuweisen

Füge Lizenzzuweisungen für eine oder mehrere E-Mail-Adressen hinzu.

PUT /api/manage/{subscriptionType}/{subscriptionID}
Content-Type: application/json

Request body

{
  "apiKey": "4024d0d8-9a7d-4ac3-9e61-efaeb7c278df",
  "emails": ["[email protected]", "[email protected]"]
}

Response

Success (200):

{
  "success": true,
  "errors": [],
  "assignmentStats": {
    "availableLicenses": 10,
    "assignedLicenses": 7
  }
}

Insufficient licenses (402):

Wird zurückgegeben, wenn du versuchst, mehr Lizenzen zuzuweisen, als in deinem Abonnement verfügbar sind.

Bad request (400):

Wird bei Validierungsfehlern wie ungültigem E-Mail-Format, doppelten E-Mails oder fehlenden Feldern zurückgegeben.

Validierungsregeln

• Mindestens eine E-Mail-Adresse muss angegeben werden
• Jede E-Mail muss ein gültiges Format haben und darf nicht länger als 256 Zeichen sein
• Doppelte E-Mails innerhalb derselben Anfrage werden abgelehnt
• Du kannst nicht mehr Lizenzen zuweisen, als in deinem Abonnement verfügbar sind

Beispiele

cURL

curl -X PUT \
  https://licensing.solinventum.com/api/manage/Paddle/ff3d3cf5-5388-40a0-915f-970c1d2d972f \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "4024d0d8-9a7d-4ac3-9e61-efaeb7c278df",
    "emails": ["[email protected]"]
  }'

PowerShell

$body = @{
    apiKey = "4024d0d8-9a7d-4ac3-9e61-efaeb7c278df"
    emails = @("[email protected]")
} | ConvertTo-Json

Invoke-RestMethod `
  -Method Put `
  -Uri "https://licensing.solinventum.com/api/manage/Paddle/ff3d3cf5-5388-40a0-915f-970c1d2d972f" `
  -ContentType "application/json" `
  -Body $body

Lizenzen entziehen

Lizenzzuweisungen von einer oder mehreren E-Mail-Adressen entfernen.

DELETE /api/manage/{subscriptionType}/{subscriptionID}
Content-Type: application/json

Request body

{
  "apiKey": "4024d0d8-9a7d-4ac3-9e61-efaeb7c278df",
  "emails": ["[email protected]"]
}

Das Format des Request body ist dasselbe wie beim Zuweisen von Lizenzen.

Response

Success (200):

{
  "success": true,
  "errors": [],
  "assignmentStats": {
    "availableLicenses": 10,
    "assignedLicenses": 6
  }
}

Bad request (400):

Wird zurückgegeben, wenn die angegebenen E-Mail-Adressen derzeit nicht dem Abonnement zugewiesen sind.

Example

curl -X DELETE \
  https://licensing.solinventum.com/api/manage/Paddle/ff3d3cf5-5388-40a0-915f-970c1d2d972f \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "4024d0d8-9a7d-4ac3-9e61-efaeb7c278df",
    "emails": ["[email protected]"]
  }'

Fehlerbehandlung

Prüfe immer das success Feld und das errors Array im Antwortkörper, um Details darüber zu erhalten, was schiefgelaufen ist.