LIVE · LANȚ DE AUDIT · UE
SISTEM · 99,99% UPTIME
v 1.0 ↗ FĂCUT ÎN UE

API Branding

Personalizați suprafețele vizibile clienților — interfața SPA, emailurile de invitație, antetele + subsolurile rapoartelor PDF — cu logo-ul, culorile de accent și numele produsului dvs. Obiectul Branding este per organizație și se aplică fiecărei sesiuni create sub acea organizație.

Obiectul Branding

{
  "logo_url": "https://cdn.acme.com/logo.png",
  "wordmark_url": "",
  "favicon_url": "https://cdn.acme.com/favicon.ico",
  "primary_color": "#0F3D91",
  "accent_color": "#FFB400",
  "product_name_override": "Acme FieldView",
  "support_email": "support@acme.com",
  "support_url": "https://help.acme.com",
  "email_from_name": "Acme Claims",
  "pdf_footer_text": "Acme Insurance — claim report",
  "updated_at": "2026-05-10T14:00:00Z"
}
CâmpTipNote
logo_urlURLPătrat sau peisaj; redat la 40px înălțime în antetul SPA, 64px în antetul PDF.
wordmark_urlURLOpțional. Folosit alături de logo_url pe interfețe mai largi.
favicon_urlURL32×32 PNG / ICO. Servit de pe CDN-ul dvs.; nu este copiat.
primary_colorhex (#rrggbb)Accent principal — folosit pentru butoane, linkuri și banda de copertă PDF.
accent_colorhex (#rrggbb)Accent secundar — folosit pentru evidențieri, insigne și trasele sparkline.
product_name_overridestring ≤ 120Înlocuiește "NexBasira" în șirurile vizibile utilizatorilor (titlul paginii, subiectele emailurilor).
support_emailemailAfișat pe paginile de eroare + în subsolurile emailurilor de invitație. Gol = valoarea implicită a platformei.
support_urlURLAcelași lucru — linkuri din meniul de ajutor al SPA.
email_from_namestring ≤ 120Numele expeditorului pe emailurile tranzacționale ieșite (rutate în continuare prin domeniul nostru autentificat pentru a menține alinierea DMARC).
pdf_footer_textstring ≤ 255Subsol pe o singură linie pe fiecare pagină a raportului de audit PDF.

Șir gol pe orice câmp = valoarea implicită a platformei. Înregistrarea Branding este creată automat la primul GET, deci nu veți vedea niciodată un 404 aici.

Citiți branding-ul

GET /api/v1/public/branding — permisiune branding:read

curl https://app.nexbasira.com/api/v1/public/branding \
  -H "Authorization: Bearer nb_sec_..."

Actualizați branding-ul

PATCH /api/v1/public/branding — permisiune branding:write

Actualizare parțială — furnizați doar câmpurile pe care doriți să le modificați. Trimiteți "" pe orice câmp pentru a-l reverta la valoarea implicită a platformei. Culorile hex sunt validate față de #rrggbb; o valoare invalidă returnează 400.

curl -X PATCH https://app.nexbasira.com/api/v1/public/branding \
  -H "Authorization: Bearer nb_sec_..." \
  -H "Content-Type: application/json" \
  -d '{
    "primary_color": "#0F3D91",
    "logo_url": "https://cdn.acme.com/logo-2026.png"
  }'

Returnează obiectul Branding actualizat. Modificarea este imediată la următoarea încărcare a paginii — nu există cache CDN de invalidat pentru SPA. Pentru emailurile de invitație + PDF-uri, noul branding se aplică oricărui conținut generat după aplicarea PATCH-ului.

Erori frecvente

StatusCodCând
400validation_errorCuloare hex invalidă, URL malformat sau șir peste lungimea maximă.
403permission_deniedCredențiala nu are permisiunea necesară (branding:read pentru GET, branding:write pentru PATCH).

Note

  • Fără încărcare de imagini. Platforma nu găzduiește activele dvs. — furnizați URL-uri HTTPS către imagini pe care le serviți deja de pe CDN-ul dvs. Astfel, invalidarea cache-ului rămâne sub controlul dvs.
  • Aplicare same-origin. URL-urile logo + favicon trebuie să servească Access-Control-Allow-Origin: * (sau originea SPA-ului dvs.) pentru ca browserul să le poată reda în widgetul iframe-embed.
  • Auditat. Fiecare PATCH generează un eveniment de audit org.branding_updated cu diferența la nivel de câmp, astfel un logo modificat poate fi urmărit până la o credențială + marcă de timp.