Branding-Optionen
Die Management API speichert sieben organisationsbezogene Branding-Werte in KV. Authentifizierte Management-Clients können sie abrufen; die automatische Darstellung in Hosted Auth und E-Mails ist nicht implementiert.
| Option | Beschreibung |
|---|---|
| Primärfarbe | Gespeicherter Primärfarbwert für Verwaltungsclients. |
| Hintergrundfarbe | Gespeicherter Seitenhintergrundwert für Verwaltungsclients. |
| Akzentfarbe | Gespeicherter Akzentfarbwert für Management-Clients. |
| Eckenradius | Gespeicherter Randradiuswert. Die API beschränkt es nicht auf einen benannten Maßstab. |
| Schriftfamilie | Gespeicherter Schriftfamilienwert. Die API ruft keine Remote-Schriftarten ab oder validiert sie nicht. |
| Logo (hell) | Gespeicherte Light-Theme-Logo-URL. Das Hochladen eines Organisationslogos ist ein separater, von R2 unterstützter Endpunkt. |
| Logo (dunkel) | Gespeicherte URL für das Dark-Theme-Logo; Diese API wendet keinen automatischen Fallback an. |
Organisationsspezifisches Branding
Jeder Datensatz ist in KV nach Mandant und Organisation indiziert. Wenn kein Datensatz vorhanden ist, geben Lesezugriffe alle sieben Felder mit null zurück. Daraus folgt keine Garantie für Laufzeit-Rendering oder Latenz.
Management-API-Endpunkt
Aktualisieren Sie das Organisations-Branding mit einem PATCH-Request und camelCase-Feldnamen. Ausgelassene Felder und null behalten derzeit den gespeicherten Wert bei; senden Sie einen neuen String, um ein Feld zu ändern.
curl -X PATCH https://xid.dev/v1/organizations/org_xxx/branding \
-H 'Authorization: Bearer sk_live_xxx' \
-H 'Content-Type: application/json' \
-d '{
"primaryColor": "#6366f1",
"borderRadius": "0.5rem",
"fontFamily": "Inter, sans-serif",
"logoUrl": "https://cdn.example.com/logo.svg"
}'Validierungsgrenze
- Das Branding-Schema akzeptiert nur die sieben oben aufgeführten Felder; Benutzerdefiniertes CSS wird nicht akzeptiert.
- Die CSS-Verarbeitung für
@importundurl()ist nicht implementiert, da der Endpunkt kein Stylesheet akzeptiert. - Werte werden als Zeichenfolgen gespeichert; Farbe, Radius, Schriftart und URL-Syntax werden über die JSON-Typen hinaus nicht validiert.
- Es gibt weder eine iframe-Vorschau noch getrennte Entwurfs- und Veröffentlichungszustände.
Abgrenzung für E-Mail-Vorlagen
Transaktions-E-Mails verwenden integrierte Mustache-Vorlagen und globale R2-Locale-Pakete. Das Hochladen organisationsspezifischer HTML-Vorlagen und die automatische Branding-Einbindung sind nicht implementiert.