Aller au contenu

Marque

Gérez les sept champs de branding d'une organisation stockés et exposés par la Management API. Leur application à l'exécution dans Hosted Auth et le CSS personnalisé ne sont pas disponibles.

Afficher en Markdown

Options de marque

La Management API stocke dans KV sept valeurs de branding propres à l’organisation. Elles sont accessibles aux clients de gestion authentifiés; le rendu automatique dans Hosted Auth et les e-mails n’est pas implémenté.

Option Description
Couleur principale Valeur de couleur primaire stockée pour les clients de gestion.
Couleur d’arrière-plan Valeur d’arrière-plan de page stockée pour les clients de gestion.
Couleur d’accent Valeur de couleur d’accent stockée pour les clients de gestion.
Rayon de bordure Valeur de rayon de bordure stockée. L’API ne le limite pas à une échelle nommée.
Famille de police Valeur de la famille de polices stockée. L’API ne récupère ni ne valide les polices distantes.
Logo (clair) URL du logo du thème lumineux stocké. Le téléchargement d’un logo d’organisation est un point de terminaison distinct soutenu par R2.
Logo (sombre) URL du logo du thème sombre stocké ; cette API n’applique pas de repli automatique.

Marque par organisation

Chaque enregistrement est indexé par tenant et organisation dans KV. Lorsqu’aucun enregistrement n’existe, les lectures renvoient les sept champs avec des valeurs null; cela n’implique aucune garantie de rendu à l’exécution ni de latence.

Point de terminaison de l’API de gestion

Mettez à jour l’image de marque de l’organisation avec une requête PATCH en utilisant les noms de champs camelCase. Les champs omis et null conservent actuellement la valeur stockée ; envoyer une chaîne de remplacement pour modifier un champ.

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"
  }'

Limite de validation

  • Le schéma de personnalisation n’accepte que les sept champs répertoriés ci-dessus ; Les CSS personnalisés ne sont pas acceptés.
  • Le traitement CSS @import et url() n’est pas implémenté car le point de terminaison n’accepte aucune feuille de style.
  • Les valeurs sont stockées sous forme de chaînes ; la couleur, le rayon, la police et la syntaxe de l’URL ne sont pas validés au-delà des types JSON.
  • Il n’existe ni aperçu dans un iframe, ni états distincts de brouillon et de publication.

Limite du modèle d’e-mail

Le courrier électronique transactionnel utilise des modèles Mustache intégrés et des packs de paramètres régionaux R2 globaux. Le téléchargement de modèles HTML par organisation et l’injection automatique de la marque ne sont pas implémentés.

Navigation

Saisissez votre recherche...

Utilisez les touches fléchées pour naviguerAppuyez sur Entrée pour sélectionnerAppuyez sur Échap pour fermer