Criar White Label

Este serviço permite a criação de uma configuração White Label, possibilitando personalizações visuais específicas para diferentes clientes (Corbans ou Promotores de Crédito). Cada White Label pode incluir logotipos, ícones e uma paleta de cores personalizada para manter a identidade visual do cliente.

Endpoint para Criar White Label

• Método: POST
• URL: https://bff-dev.granatech.com.br/api/whitelabel

Estrutura de Dados para White Label

O objeto WhiteLabel contém as seguintes propriedades para definir a identidade visual e as configurações de um cliente específico:

Campos do Objeto WhiteLabel

• name (string, obrigatório): Nome do White Label.
• status (string, opcional): Status atual do White Label.
• primaryLogo (string, obrigatório): URL ou caminho para o logotipo principal.
• secondaryLogo (string, obrigatório): URL ou caminho para o logotipo secundário.
• favicon (string, obrigatório): URL ou caminho para o ícone favicon.
• primaryColor (string, obrigatório): Cor primária em formato hexadecimal.
• secondaryColor (string, obrigatório): Cor secundária em formato hexadecimal.
• tertiaryColor (string, opcional): Cor terciária em formato hexadecimal.
• corbanId (number, opcional): ID do Corban associado, se aplicável.
• creditPromoterId (number, opcional): ID do Promotor de Crédito associado, se aplicável.
• slug (string, obrigatório): Identificador único do White Label, utilizado em URLs e para personalização de rotas.
• enabled (boolean, opcional): Indica se o White Label está ativo.

Exemplo de Dados para Criar White Label

{
  "name": "Exemplo de White Label",
  "primaryLogo": "https://exemplo.com/logos/primary-logo.png",
  "secondaryLogo": "https://exemplo.com/logos/secondary-logo.png",
  "favicon": "https://exemplo.com/favicon.ico",
  "primaryColor": "#123456",
  "secondaryColor": "#654321",
  "tertiaryColor": "#abcdef",
  "corbanId": 1,
  "slug": "exemplo-white-label",
  "enabled": true
}

Exemplo de Requisição com curl para Criar White Label

curl -X POST https://bff-dev.granatech.com.br/api/whitelabel \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Exemplo de White Label",
    "primaryLogo": "https://exemplo.com/logos/primary-logo.png",
    "secondaryLogo": "https://exemplo.com/logos/secondary-logo.png",
    "favicon": "https://exemplo.com/favicon.ico",
    "primaryColor": "#123456",
    "secondaryColor": "#654321",
    "tertiaryColor": "#abcdef",
    "corbanId": 1,
    "slug": "exemplo-white-label",
    "enabled": true
  }'

Observações

1. Identificação do Cliente: O corbanId e creditPromoterId são campos opcionais, mas um deles deve ser incluído para associar o White Label ao cliente específico.
2. Identidade Visual Completa: Os campos primaryLogo, secondaryLogo, favicon, e primaryColor são obrigatórios para definir a identidade visual completa do White Label.
3. Slug Único: O campo slug é obrigatório e deve ser único para cada White Label, servindo como identificador nas URLs e na personalização de rotas.
4. Status e Ativação: O campo enabled permite habilitar ou desabilitar o White Label, controlando sua disponibilidade no sistema.

Esse endpoint facilita a criação e gestão de White Labels, garantindo que cada cliente mantenha uma identidade visual consistente e personalizada no sistema.