Wie benutze ich die Lizenz-API, um Lizenzen programmgesteuert zu verwalten?

Lerne, wie du die SecureMailMerge-Lizenzierungs-REST-API verwendest, um Lizenzen programmgesteuert mit API-Schlüsseln zuzuweisen und zu entziehen.

Der Lizenzserver bietet eine REST-API, 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 jeden, der das Lizenzmanagement in seine eigenen Tools integrieren möchte.

Authentifizierung und Basis-URL

Alle API-Anfragen werden mit einem API-Schlüssel authentifiziert. Der API-Schlüssel ist eine GUID, die du im Anfragekörper (nicht im Header) einfügst.

Alle API-Endpunkte sind verfügbar unter:

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

Wo:

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

Du musst diese URL nicht selbst erstellen. Gehe auf dem Lizenzserver zur Seite “Lizenzen zuweisen” deines Abonnements und wähle den Tab Lizenzen über API zuweisen. Dort wird die vollständige Basis-URL, dein API-Schlüssel und ein einsatzbereites JSON-Payload für dein Abonnement angezeigt.

Regenerierung deines API-Schlüssels

Wenn dein API-Schlüssel kompromittiert ist, kannst du ihn von derselben Seite aus regenerieren. Der alte Schlüssel wird sofort ungültig. Nur der Abonnementinhaber kann API-Schlüssel regenerieren. Verwende immer HTTPS, wenn du die API aufrufst, 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 zu einer oder mehreren E-Mail-Adressen hinzu.

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

Anfragekörper

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

Antwort

Erfolg (200):

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

Nicht genügend Lizenzen (402):

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

Ungültige Anfrage (400):

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

Validierungsregeln

• Es muss mindestens eine E-Mail-Adresse 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 abbestellen

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

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

Anfragekörper

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

Das Format des Anfragekörpers ist dasselbe wie bei der Zuweisung von Lizenzen.

Antwort

Erfolg (200):

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

Ungültige Anfrage (400):

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

Beispiel

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

Überprüfe immer das success Feld und das errors Array im Antwortkörper, um Details zu erfahren, was schiefgelaufen ist.