Ir para o conteúdo

Identidade visual

Gerencie os sete campos de identidade visual da organização armazenados e expostos pela Management API. A aplicação em runtime no Hosted Auth e o CSS personalizado não estão disponíveis.

Ver como Markdown

Opções de identidade visual

A Management API armazena no KV sete valores de identidade visual por organização. Eles ficam disponíveis para clientes de gerenciamento autenticados; a renderização automática no Hosted Auth e em e-mails não está implementada.

Opcao Descrição
Cor primária Valor de cor primária armazenado para clientes de gerenciamento.
Cor de fundo Valor de plano de fundo da página armazenado para clientes de gerenciamento.
Cor de destaque Valor de cor de destaque armazenado para clientes de gerenciamento.
Raio da borda Valor armazenado do raio da borda. A API não a restringe a uma escala nomeada.
Família da fonte Valor da família de fontes armazenado. A API não busca nem valida fontes remotas.
Logotipo (claro) URL do logotipo de tema claro armazenado. O upload do logotipo de uma organização é um endpoint separado com suporte do R2.
Logotipo (escuro) URL do logotipo de tema escuro armazenado; esta API não aplica um substituto automático.

Identidade visual por organização

Cada registro é indexado por tenant e organização no KV. Quando não há registro, as leituras retornam os sete campos com valores null; isso não implica garantia de renderização em runtime nem de latência.

Endpoint da Management API

Atualize a marca da organização com uma solicitação PATCH usando nomes de campo camelCase. Os campos omitidos e null atualmente retêm o valor armazenado; envie uma string de substituição para alterar um 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"
  }'

Limite de validação

  • O esquema de marca aceita apenas os sete campos listados acima; CSS personalizado não é aceito.
  • O processamento CSS de @import e url() não foi implementado porque o endpoint não aceita folhas de estilo.
  • Os valores são armazenados como strings; cor, raio, fonte e sintaxe de URL não são validados além dos tipos JSON.
  • Não há visualização em iframe nem estados separados de rascunho e publicação.

Limite do modelo de email

O e-mail transacional usa modelos Mustache integrados e pacotes de localidade globais R2. O upload de modelos HTML por organização e a injeção automática de marca não são implementados.

Navegação

Digite para pesquisar...

Use as teclas de seta para navegarPressione Enter para selecionarPressione Escape para fechar