Obtener Branding

Obtiene la configuracion de branding (logo y colores) de tu organizacion.

Endpoint

GET https://api.lummy.io/v1/branding

Entorno	URL
Producción	https://api.lummy.io/v1/branding
Sandbox	https://sandbox.lummy.io/v1/branding

Headers

{

"Authorization": string,requerido

↳Token de autenticación Bearer (JWT) para validar la identidad del usuario y sus permisos de acceso.

"x-organization-id": stringrequerido

↳Identificador único (UUID) de la organización. Se utiliza para filtrar y obtener el branding específico de la organización autenticada.

↳Formato: uuid

}

Ejemplos de Codigo

cURL

curl -X GET https://sandbox.lummy.io/branding \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "x-organization-id: ${LUMMY_ORG_ID}"

Node.js (TypeScript)

import axios from 'axios';

interface BrandingResponse {
  id: string;
  organizationId: string;
  logoUrl: string | null;
  primaryColor: string | null;
  secondaryColor: string | null;
  createdAt: string;
  updatedAt: string;
}

async function obtenerBranding(): Promise<BrandingResponse | null> {
  const API_URL = 'https://sandbox.lummy.io/branding';
  const ACCESS_TOKEN = process.env.ACCESS_TOKEN!;
  const ORG_ID = process.env.LUMMY_ORG_ID!;

  const response = await axios.get<BrandingResponse>(API_URL, {
    headers: {
      'Authorization': `Bearer ${ACCESS_TOKEN}`,
      'x-organization-id': ORG_ID,
    },
  });

  console.log('Branding:', response.data);
  return response.data;
}

obtenerBranding();

Python

import os
import requests

def obtener_branding():
    api_url = "https://sandbox.lummy.io/branding"
    access_token = os.getenv("ACCESS_TOKEN")
    org_id = os.getenv("LUMMY_ORG_ID")

    headers = {
        "Authorization": f"Bearer {access_token}",
        "x-organization-id": org_id,
    }

    response = requests.get(api_url, headers=headers)
    response.raise_for_status()

    data = response.json()
    print(f"Branding: {data}")
    return data

if __name__ == "__main__":
    obtener_branding()

PHP (Guzzle)

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

function obtenerBranding(): ?array
{
    $client = new Client([
        'base_uri' => 'https://sandbox.lummy.io',
        'headers' => [
            'Authorization' => 'Bearer ' . getenv('ACCESS_TOKEN'),
            'x-organization-id' => getenv('LUMMY_ORG_ID'),
        ],
    ]);

    $response = $client->get('/branding');
    $data = json_decode($response->getBody(), true);

    echo "Branding obtenido\n";
    return $data;
}

obtenerBranding();

Respuestas

200 OK

Branding obtenido exitosamente.

{

"id": string,opcional

↳Identificador único del registro de branding en el sistema.

↳Formato: uuid

↳Ejemplo: "550e8400-e29b-41d4-a716-446655440000"

"organizationId": string,opcional

↳Identificador único de la organización a la que pertenece este branding.

↳Formato: uuid

↳Ejemplo: "123e4567-e89b-12d3-a456-426614174000"

"logoUrl": string,opcional

↳URL completa del logotipo almacenado en Amazon S3. Este logotipo aparece en el encabezado de los PDFs de las facturas. Retorna null si no se ha configurado un logotipo.

↳Ejemplo: "https://bucket.s3.region.amazonaws.com/organizations/uuid/branding/logo.png"

"primaryColor": string,opcional

↳Color primario de la marca en formato hexadecimal. Se utiliza en el encabezado y elementos principales del PDF de las facturas. Debe incluir el símbolo # seguido de 6 caracteres hexadecimales (0-9, A-F). Retorna null si no se ha configurado.

↳Patrón: ^#[0-9A-Fa-f]{6}$

↳Ejemplo: "#4F46E5"

"secondaryColor": string,opcional

↳Color secundario de la marca en formato hexadecimal. Se utiliza para acentos y elementos secundarios en el PDF de las facturas. Debe incluir el símbolo # seguido de 6 caracteres hexadecimales (0-9, A-F). Retorna null si no se ha configurado.

↳Patrón: ^#[0-9A-Fa-f]{6}$

↳Ejemplo: "#10B981"

"createdAt": string,opcional

↳Fecha y hora de creación del registro de branding en formato ISO 8601 (UTC).

↳Formato: date-time

↳Ejemplo: "2025-01-15T10:30:00.000Z"

"updatedAt": stringopcional

↳Fecha y hora de la última actualización del branding en formato ISO 8601 (UTC). Se actualiza cuando se modifica el logotipo o los colores.

↳Formato: date-time

↳Ejemplo: "2025-01-15T10:30:00.000Z"

}

{
  "requestId": "abc123-def456",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "logoUrl": "https://bucket.s3.region.amazonaws.com/organizations/uuid/branding/logo.png",
    "primaryColor": "#4F46E5",
    "secondaryColor": "#10B981",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  },
  "timestamp": "2025-01-15T10:30:00.000Z",
  "path": "/branding",
  "method": "GET"
}

200 OK (Sin branding configurado)

Si la organizacion no tiene branding configurado, retorna null.

{
  "requestId": "abc123-def456",
  "data": null,
  "timestamp": "2025-01-15T10:30:00.000Z",
  "path": "/branding",
  "method": "GET"
}