PT EN

Marca

URL base: $PUBLIC_API

O objecto
{
  "name": "Ana Matsinhe",
  "short_name": "Ana Matsinhe",
  "legal_name": "Ana Matsinhe",
  "copyright": "copyright",
  "support": {
    "email": "ana.matsinhe@example.org",
    "phone": "+258841234567",
    "url": "https://example.org/"
  },
  "links": {
    "website": "website",
    "terms": "terms",
    "privacy": "privacy"
  },
  "colors": {
    "brand": "brand",
    "brand_foreground": "brand foreground",
    "accent": "accent"
  },
  "logo_url": "https://example.org/",
  "logo_dark_url": "https://example.org/",
  "icon_url": "https://example.org/",
  "updated_at": "2026-11-19T09:30:00Z"
}

Obter a marca do produto

Registos

GET /branding

The commercial name, contacts, links, colours and logo files. Configuration (branding) sets the defaults and the platform owner can override each value. Sends an ETag and Cache-Control public, max-age=60, and answers If-None-Match with 304. Clients cache the last brand and never block start-up on it. With tenant=<slug> it returns that utility's effective brand: per field, the utility's runtime value, its static value (branding.tenants), its business profile, then the platform brand.

Parâmetros

tenantstring · consulta · opcional

A utility's slug

If-None-Matchstring · cabeçalho · opcional

One or more ETag values from a previous response, comma separated, weak (W/) tags and * accepted; when one matches the current brand document the server answers 304 with no body.

Devolve

200 Brand

Erros 404

curl -X GET "$PUBLIC_API/branding"
Resposta 200
{
  "name": "Ana Matsinhe",
  "short_name": "Ana Matsinhe",
  "legal_name": "Ana Matsinhe",
  "copyright": "copyright",
  "support": {
    "email": "ana.matsinhe@example.org",
    "phone": "+258841234567",
    "url": "https://example.org/"
  },
  "links": {
    "website": "website",
    "terms": "terms",
    "privacy": "privacy"
  },
  "colors": {
    "brand": "brand",
    "brand_foreground": "brand foreground",
    "accent": "accent"
  },
  "logo_url": "https://example.org/",
  "logo_dark_url": "https://example.org/",
  "icon_url": "https://example.org/",
  "updated_at": "2026-11-19T09:30:00Z"
}

Obter um ficheiro da marca de uma empresa

Registos

GET /branding/tenants/{slug}/assets/{kind}

Same caching as the platform files. Only the utility's own files are served; a utility never inherits the platform's.

Parâmetros

slugstring · caminho · obrigatório

Public slug of the tenant (utility workspace) whose brand file is requested; an unknown slug answers 404.

kindstring · caminho · obrigatório

Which tenant brand file to return: logo, logo_dark or icon; any other value, or a file the tenant has not set, answers 404.

um de logo, logo_dark, icon

vstring · consulta · opcional

File version hash, as carried in the tenant's asset URLs; when it equals the current file's hash the response is cached for a year as immutable, otherwise for 60 seconds, and the file served is always the current one.

Devolve

200 File

Erros 404

curl -X GET "$PUBLIC_API/branding/tenants/{slug}/assets/{kind}"
Resposta 200

File

Obter um ficheiro da marca

Registos

GET /branding/assets/{kind}

A brand file (logo, dark logo or icon)

Served with its content type. When the v query matches the current file hash the response is cached for a year (immutable); the asset URLs in the brand carry it. SVG files are served sanitised, without scripts, event handlers or external references.

Parâmetros

kindstring · caminho · obrigatório

Which platform brand file to return: logo, logo_dark or icon; any other value answers 404.

um de logo, logo_dark, icon

vstring · consulta · opcional

File version hash, as carried in the asset URLs of the branding document; when it equals the current file's hash the response is cached for a year as immutable, otherwise for 60 seconds, and the file served is always the current one.

Devolve

200 File

Erros 404

curl -X GET "$PUBLIC_API/branding/assets/{kind}"
Resposta 200

File