Branding API
Tilpass de kundevendte flatene — SPA-rammeverket, invitasjons-e-poster, topp- og bunntekster i PDF-rapporter — med din logo, aksentfarger og produktnavn. Branding-objektet er per org og gjelder hver økt som opprettes under den org-en.
Branding-objektet
{
"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"
} | Felt | Type | Merknader |
|---|---|---|
logo_url | URL | Kvadratisk eller liggende; gjengis 40px høy i SPA-headeren, 64px i PDF-headeren. |
wordmark_url | URL | Valgfritt. Brukes sammen med logo_url på bredere rammeverk. |
favicon_url | URL | 32×32 PNG / ICO. Serveres fra din CDN; speiles ikke. |
primary_color | hex (#rrggbb) | Hovedaksent — brukes for knapper, lenker og PDF-forsidebåndet. |
accent_color | hex (#rrggbb) | Sekundæraksent — brukes for uthevinger, merker og sparkline-streker. |
product_name_override | string ≤ 120 | Erstatter "NexBasira" i brukersynlige strenger (sidetittel, emnelinjer i e-post). |
support_email | Vises på feilsider + i bunntekster i invitasjons-e-poster. Tom = plattformstandard. | |
support_url | URL | Samme — lenker fra hjelpemenyen i SPA-en. |
email_from_name | string ≤ 120 | Fra-navn på utgående transaksjons-e-post (fortsatt rutet via vårt autentiserte domene for å bevare DMARC-justering). |
pdf_footer_text | string ≤ 255 | Bunntekst på én linje på hver side av PDF-audit-rapporten. |
Tom streng på ethvert felt = plattformstandard. Branding-raden opprettes automatisk ved første GET, så du ser aldri en 404 her.
Les branding
GET /api/v1/public/branding — scope branding:read
curl https://app.nexbasira.com/api/v1/public/branding \
-H "Authorization: Bearer nb_sec_..." Oppdater branding
PATCH /api/v1/public/branding — scope branding:write
Delvis oppdatering — oppgi kun feltene du vil endre. Send "" på ethvert felt for å tilbakestille det til plattformstandarden. Hex-farger valideres mot #rrggbb; en ugyldig verdi returnerer 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"
}' Returnerer det nettopp oppdaterte Branding-objektet. Endringen er umiddelbar ved neste sidelasting — det finnes ingen CDN-cache å tømme for SPA-en. For invitasjons-e-poster + PDF-er gjelder den nye brandingen alt som genereres etter at PATCH lander.
Vanlige feil
| Status | Kode | Når |
|---|---|---|
| 400 | validation_error | Ugyldig hex-farge, feilformatert URL, eller streng over maksimal lengde. |
| 403 | permission_denied | Legitimasjonen mangler scope (branding:read for GET, branding:write for PATCH). |
Merknader
- Ingen bildeopplasting. Plattformen hoster ikke ressursene dine — oppgi HTTPS-URL-er til bilder du allerede serverer fra din CDN. Dette holder cache-invalidering under din kontroll.
- Same-origin-håndhevelse. Logo- + favicon-URL-er må servere
Access-Control-Allow-Origin: *(eller din SPA-origin) slik at nettleseren kan gjengi dem inne i iframe-embed-widgeten. - Revidert. Hver PATCH lander en
org.branding_updated-audit-hendelse med diff på feltnivå, så en manipulert logo kan spores til en legitimasjon + tidsstempel.