Pular para o conteúdo principal

Atualizar White Label

Este endpoint permite atualizar as configurações de um White Label existente, possibilitando a modificação de detalhes visuais e associações ao Corban ou Promotor de Crédito.

Endpoint para Atualizar White Label​

  • Método: PUT
  • URL: https://bff-dev.granatech.com.br/api/whitelabel/{id}

Parâmetros de Caminho​

  • id (string, obrigatório): O identificador único do White Label a ser atualizado.

Estrutura de Dados para Atualização​

O objeto WhiteLabel possui campos que permitem customizar a identidade visual do Corban ou Promotor de Crédito.

Campos do Objeto WhiteLabel​

  • name (string, obrigatório): Nome do White Label.
  • primaryLogo (string, obrigatório): URL do logotipo primário.
  • secondaryLogo (string, obrigatório): URL do logotipo secundário.
  • favicon (string, obrigatório): URL do favicon.
  • primaryColor (string, obrigatório): Cor primária do tema.
  • secondaryColor (string, obrigatório): Cor secundária do tema.
  • tertiaryColor (string, opcional): Cor terciária do tema.
  • corbanId (number, opcional): ID do Corban associado ao White Label, se aplicável.
  • creditPromoterId (number, opcional): ID do Promotor de Crédito associado, se aplicável.
  • slug (string, obrigatório): Slug único para identificar o White Label.
  • enabled (boolean, opcional): Status do White Label (habilitado ou desabilitado).

Exemplo de Dados para Atualização do White Label​

{
  "name": "Novo White Label",
  "primaryLogo": "https://exemplo.com/logo_primario.png",
  "secondaryLogo": "https://exemplo.com/logo_secundario.png",
  "favicon": "https://exemplo.com/favicon.ico",
  "primaryColor": "#003366",
  "secondaryColor": "#005599",
  "tertiaryColor": "#3399cc",
  "corbanId": 1,
  "creditPromoterId": 2,
  "slug": "novo-white-label",
  "enabled": true
}

Exemplo de Requisição com curl para Atualizar White Label​

curl -X PUT https://bff-dev.granatech.com.br/api/whitelabel/a1b2c3d4e5f6 \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Novo White Label",
    "primaryLogo": "https://exemplo.com/logo_primario.png",
    "secondaryLogo": "https://exemplo.com/logo_secundario.png",
    "favicon": "https://exemplo.com/favicon.ico",
    "primaryColor": "#003366",
    "secondaryColor": "#005599",
    "tertiaryColor": "#3399cc",
    "corbanId": 1,
    "creditPromoterId": 2,
    "slug": "novo-white-label",
    "enabled": true
  }'

Observações​

  1. Slug Único: O slug é um identificador exclusivo do White Label e deve ser único para cada cliente.
  2. Uso do Corban e Promotor de Crédito: Se aplicável, os IDs corbanId e creditPromoterId podem ser associados para vincular o White Label a uma entidade específica.
  3. Campos Obrigatórios: Certifique-se de incluir todos os campos obrigatórios no corpo da solicitação para evitar erros.

Com este endpoint, é possível personalizar e atualizar facilmente a identidade visual e associações de um White Label.