Branding-API
Pas de klantgerichte oppervlakken aan — SPA-chrome, uitnodigingsmails, headers + footers van PDF-rapporten — met uw logo, accentkleuren en productnaam. Het Branding-object is per org en geldt voor elke sessie die onder die org wordt aangemaakt.
Het Branding-object
{
"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"
} | Veld | Type | Opmerkingen |
|---|---|---|
logo_url | URL | Vierkant of liggend; weergegeven op 40px hoog in de SPA-header, 64px in de PDF-header. |
wordmark_url | URL | Optioneel. Gebruikt naast logo_url op bredere chrome. |
favicon_url | URL | 32×32 PNG / ICO. Geserveerd vanaf uw CDN; niet gespiegeld. |
primary_color | hex (#rrggbb) | Hoofdaccent — gebruikt voor knoppen, links en de PDF-omslagband. |
accent_color | hex (#rrggbb) | Secundair accent — gebruikt voor highlights, badges en sparkline-lijnen. |
product_name_override | string ≤ 120 | Vervangt "NexBasira" in voor gebruikers zichtbare strings (paginatitel, e-mailonderwerpregels). |
support_email | Getoond op foutpagina's + in footers van uitnodigingsmails. Leeg = platformstandaard. | |
support_url | URL | Idem — linkt vanuit het SPA-helpmenu. |
email_from_name | string ≤ 120 | From-naam op uitgaande transactionele mail (nog steeds gerouteerd via ons geverifieerde domein om DMARC-alignment te behouden). |
pdf_footer_text | string ≤ 255 | Footer van één regel op elke pagina van het PDF-auditrapport. |
Lege string op een veld = platformstandaard. De Branding-rij wordt automatisch aangemaakt bij de eerste GET, dus u ziet hier nooit een 404.
Branding lezen
GET /api/v1/public/branding — scope branding:read
curl https://app.nexbasira.com/api/v1/public/branding \
-H "Authorization: Bearer nb_sec_..." Branding bijwerken
PATCH /api/v1/public/branding — scope branding:write
Gedeeltelijke update — geef alleen de velden op die u wilt wijzigen. Stuur "" op een veld om het terug te zetten naar de platformstandaard. Hex-kleuren worden gevalideerd tegen #rrggbb; een ongeldige waarde geeft 400 terug.
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"
}' Geeft het zojuist bijgewerkte Branding-object terug. De wijziging is direct actief bij de volgende paginalading — er is geen CDN-cache die u voor de SPA hoeft te legen. Voor uitnodigingsmails + PDF's geldt de nieuwe branding voor alles wat na de PATCH wordt gegenereerd.
Veelvoorkomende fouten
| Status | Code | Wanneer |
|---|---|---|
| 400 | validation_error | Ongeldige hex-kleur, misvormde URL of string boven de maximale lengte. |
| 403 | permission_denied | Credential mist de scope (branding:read voor GET, branding:write voor PATCH). |
Opmerkingen
- Geen afbeeldingsupload. Het platform host uw assets niet — geef HTTPS-URL's naar afbeeldingen die u al vanaf uw CDN serveert. Zo houdt u cache-invalidatie in eigen hand.
- Same-origin-handhaving. Logo- + favicon-URL's moeten
Access-Control-Allow-Origin: *(of uw SPA-origin) serveren zodat de browser ze binnen de iframe-embed-widget kan weergeven. - Geaudit. Elke PATCH plaatst een
org.branding_updated-auditevent met de diff op veldniveau, zodat een gemanipuleerd logo herleidbaar is tot een credential + tijdstempel.