Saltar al contenido

Marca

Gestiona los siete campos de branding de la organización almacenados y expuestos por la Management API. La aplicación en runtime de Hosted Auth y el CSS personalizado no están disponibles.

Ver como Markdown

Opciones de marca

La Management API almacena en KV siete valores de branding por organización. Están disponibles para clientes de gestión autenticados; el renderizado automático en Hosted Auth y en el correo electrónico no está implementado.

Opción Descripción
Color principal Valor de color primario almacenado para clientes de administración.
Color de fondo Valor de fondo de página almacenado para clientes de administración.
Color de acento Valor de color de acento almacenado para clientes de administración.
Radio de borde Valor de radio de borde almacenado. La API no lo limita a una escala con nombre.
Familia tipográfica Valor de familia de fuentes almacenado. La API no busca ni valida fuentes remotas.
Logo (claro) URL del logotipo de tema claro almacenado. La carga del logotipo de una organización es un punto final independiente respaldado por R2.
Logo (oscuro) URL del logotipo de tema oscuro almacenado; Esta API no aplica un respaldo automático.

Marca por organización

Cada registro se indexa por tenant y organización en KV. Las lecturas devuelven los siete campos con valores null cuando no existe un registro; esto no implica garantías de renderizado en runtime ni de latencia.

Endpoint de la API de administración

Actualice la marca de la organización con una solicitud PATCH usando nombres de campo camelCase. Los campos omitidos y null conservan actualmente el valor almacenado; envíe una cadena de reemplazo para cambiar un campo.

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

Límite de validación

  • El esquema de marca acepta sólo los siete campos enumerados anteriormente; No se acepta CSS personalizado.
  • El procesamiento CSS de @import y url() no está implementado porque el endpoint no acepta hojas de estilo.
  • Los valores se almacenan como cadenas; el color, el radio, la fuente y la sintaxis de URL no se validan más allá de los tipos JSON.
  • No hay vista previa en iframe ni estados separados de borrador y publicación.

Límite de la plantilla de correo electrónico

El correo electrónico transaccional utiliza plantillas Mustache integradas y paquetes locales globales R2. No se implementan la carga de plantillas HTML por organización ni la inyección automática de marca.

Navegación

Escribe para buscar...

Usa las flechas para navegarPulsa Intro para seleccionarPulsa Escape para cerrar