Zum Inhalt springen
CCyrellian
Suchen…Ctrl K

Update-API

Update-Prüfung, Downloads und CI-Upload.

Basis-URL je Produkt: https://updates.cyrellian.com/<produkt>.

Update prüfen

GET /v1/check?edition=basic|unlimited&channel=stable|beta&version=1.2.3&instance=<instanceId>
Authorization: Bearer <lizenz>     (optional)
X-Update-Key: <update-schlüssel>   (optional)

Antwort:

{
  "latest": { "version": "1.3.0", "releasedAt": "…", "notes": "…", "critical": false, "manual": true,
              "sha256": "…", "signature": "…", "downloadUrl": "…" },
  "plugins": [{ "id": "newsletter", "version": "1.0.0", "sha256": "…", "signature": "…", "premium": false, "downloadUrl": "…" }],
  "changelog": [{ "version": "1.3.0", "releasedAt": "…", "notes": "…" }]
}
  • downloadUrl ist eine Stunde gültig – danach einfach erneut prüfen.
  • Eingeschränkte Varianten (z. B. unlimited) liefern statt downloadUrl ein requiresAuthorization: true, wenn weder der Tarif der Lizenz noch ein Update-Schlüssel sie erlaubt.
  • manual: true = die Release Notes verlangen manuelle Schritte, nie automatisch installieren.
  • Image-basierte Produkte (Docsello) liefern image (z. B. ghcr.io/ceddini/docsello:0.2.0) statt einer Datei.

Vor dem Installieren prüft die Installation SHA-256 und Signatur.

Anwendungen mit Lizenzschlüsseln

Hat eine Anwendung Lizenzschlüssel und Releases & Updates eingeschaltet (Konsole → Anwendung → Einstellungen), fragt die Software mit dem Token ihrer Aktivierung nach Updates – ohne instance:

GET /v1/check?edition=<variante>&channel=stable|beta&version=1.2.3
Authorization: Bearer <token aus /license/v1/activate oder /validate>
  • edition ist die Variante, z. B. eine pro Betriebssystem (windows-x86_64, macos-aarch64) – festgelegt in den Release-Optionen der Anwendung. Unbekannte Werte bekommen die erste Variante.
  • Der Schlüssel wird bei jeder Prüfung neu gelesen: gesperrt, widerrufen oder abgelaufen → kein downloadUrl.
  • Mit „Nur mit gültiger Lizenz“ (Standard für „Software mit Lizenzschlüsseln“) bekommt eine Prüfung ohne gültiges Token requiresAuthorization: true statt downloadUrl; mit „Alle“ lädt jeder.
  • Private Varianten (Release-Optionen → „Private Varianten“) sind für interne Builds, z. B. eine Familien- oder Entwicklerversion. Nur ein Update-Schlüssel für genau diese Variante lädt sie (X-Update-Key: cyr_upd_…). Lizenz- und Schlüssel-Tokens zählen dort nicht, „Alle“ öffnet sie nicht; ohne Schlüssel antwortet die Prüfung mit latest: null und leerem changelog. Unbekannte Editionen bekommen die erste öffentliche Variante.
  • Prüfen wie oben: SHA-256 der Datei und die Ed25519-Signatur über <variante>:<version>:<sha256> mit dem öffentlichen Schlüssel aus GET /license/v1/public-key.

Add-ons für Lizenzschlüssel

Mit Add-ons (Konsole → Anwendung → Einstellungen) verteilt und verkauft eine Anwendung Zusätze – Plugins, Datenpakete wie Maschinendaten oder Garnpaletten, was auch immer. Cyrellian schaut nicht hinein: ein Add-on ist eine signierte, versionierte Datei mit Preis; was sie enthält und wie sie benutzt wird, entscheidet die Software.

Was ein Schlüssel nutzen darf

  • kostenlose Add-ons: jeder (bei „Nur mit gültiger Lizenz“ nur mit gültigem Token);
  • Bezahl-Add-ons aus den Paketen seines Tarifs, oder alle, wenn der Tarif Alles freigeschaltet hat;
  • was für genau diesen Schlüssel gekauft oder freigeschaltet wurde (einzeln oder als Paket).

/v1/check mit dem Token listet unter plugins die neueste Version jedes Add-ons, das der Schlüssel nutzen darf – mit downloadUrl, sha256 und signature. Gekauftes steht schon in der nächsten Prüfung drin. Das Token aus /license/v1/activate bzw. /validate trägt zusätzlich addons (IDs der freigeschalteten Bezahl-Add-ons) für die Offline-Prüfung.

Signatur prüfen: Ed25519 über plugin:<id>:<version>:<sha256> mit dem öffentlichen Schlüssel aus GET /license/v1/public-key.

Add-on-Shop in der Software

GET /v1/addons
Authorization: Bearer <token>   (optional)
{
  "addons": [{ "id": "brother-pr", "name": "Brother PR series", "description": "…", "category": "Maschinen",
               "version": "1.2.0", "premium": true, "bundle": null, "owned": false,
               "offers": [{ "model": "one_time", "price": 900, "currency": "eur" }],
               "buyUrl": "https://account.cyrellian.com/<app>/buy?item=addon%3Abrother-pr&key=<kid>" }],
  "bundles": [{ "code": "all-machines", "name": { "de": "Alle Maschinen", "en": "All machines" },
                "addons": ["janome-mb"], "offers": [], "buyUrl": null }]
}
  • Gelistet ist jedes Add-on mit einer veröffentlichten stabilen Version. Preise sind netto in Cent.
  • owned: mit Token true/false, ohne Token null (kostenlose immer true).
  • buyUrl öffnest du im Browser. Mit Token nennt der Link den Schlüssel (key=<kid>): der Kauf landet direkt auf diesem Schlüssel, die nächste Update-Prüfung liefert das Add-on. Ohne Token wählt der Käufer den Schlüssel später in seinem Konto unter Abrechnung. null, wenn es nicht einzeln käuflich ist (nur im Paket) oder schon gehört.
  • category ist freier Text aus dem Katalog – zum Gruppieren in deiner Oberfläche.

Upload aus der CI

Am einfachsten mit der Cyrellian-CLI: cyrellian release upload / cyrellian release plugin (cyrellian help zeigt die Optionen). Darunter liegt diese Schnittstelle:

POST /ci/release   Authorization: Bearer <CI-Token>   multipart/form-data
  variant (eine der Varianten der Anwendung), version, channel (stable|beta), notes, notesUrl, critical, publish (true|false), image?, file?
POST /ci/plugin    (Anwendungen mit Add-ons; /ci/addon ist dasselbe)
  file (Paket), channel, notes, publish, addonId?, version?, minAppVersion?, name?, description?, category?, author?

Paketformat cyrellian-addon/1 für eigene Anwendungen: entweder ein zip mit manifest.json im Wurzelverzeichnis oder eine JSON-Datei { "format": "cyrellian-addon/1", "manifest": { … } }. Das Manifest:

{ "id": "brother-pr", "version": "1.2.0", "name": "Brother PR series", "minAppVersion": "2.0.0" }

Ohne Manifest (beliebige Datei) schickt die CI addonId und version als Felder mit. Neue IDs landen als kostenloses Add-on im Katalog; Preis, Paket und Kategorie legst du in der Konsole fest (Katalog → Add-ons).

409 heißt: diese Version gibt es schon (z. B. erneuter Workflow-Lauf) – kein Fehler. CI-Tokens erzeugt ein Operator in der Konsole; signiert wird auf dem Server, die CI sieht den Schlüssel nie.

War diese Seite hilfreich?Aktualisiert am 17. Oktober 2026