Domínio próprio e marca (white label)

Com o white label, os seus usuários acessam o Portal e o Backoffice por um endereço da sua empresa, como portal.suaempresa.com.br, e veem o seu nome, as suas cores e os seus logos na tela de acesso, nos painéis e na Central de Ajuda.

O white label muda só as telas. A API de integração continua em https://api.monkeypay.app/api/v2, com as mesmas credenciais e o mesmo contrato. Veja URL base e ambientes.

Pré-requisitos

• A marca pertence à empresa principal, a organização sem empresa-mãe. Subempresas não têm marca própria: os usuários delas usam o domínio e a marca da principal.
• Acesso ao provedor de DNS do domínio da sua empresa.
• Um subdomínio para cada painel que você for usar. Portal e Backoffice precisam de endereços diferentes.

1. Reúna a marca

A marca é configurada no Backoffice, em Empresas → empresa principal → Configurações → Marca e domínio. Hoje essa área é operada pela administração da plataforma MonkeyPay: envie as informações abaixo pelo seu canal de atendimento.

A referência da API não documenta uma operação para gravar a marca. Não tente configurá-la por chamadas à API de integração.

Identidade

A interface ajusta automaticamente a cor de ação quando ela não tem contraste suficiente para leitura (WCAG 2.1) e aplica a cor da marca aos tons neutros.

Imagens

Formatos aceitos: PNG, JPEG, WebP ou ICO, com até 2 MiB por arquivo. As imagens são enviadas pelo editor e servidas pelo CDN da plataforma.

Sem ícone nem favicon, o navegador mostra as iniciais do nome do produto.

Domínios, suporte e tela de acesso

Domínios são gravados em letras minúsculas.

2. Aponte o domínio

No provedor de DNS do seu domínio, crie um registro CNAME para cada endereço:

O destino exato também aparece no editor, na aba Domínios e suporte, em Como publicar um domínio.

• Use um subdomínio. O domínio raiz (suaempresa.com.br) não aceita CNAME na maioria dos provedores.
• A propagação do DNS pode levar algumas horas. Até lá, o endereço pode não abrir ou mostrar a marca anterior.

Crie o CNAME antes de pedir a publicação. O certificado HTTPS do domínio é emitido pela plataforma só quando o DNS já aponta para ela. Se o domínio for publicado antes, a publicação precisa ser reaplicada pela administração; enquanto isso, quem usa a Cloudflare com SSL estrito vê o erro 526.

3. Publicação

Depois de salvar a marca, o editor informa uma de três situações:

4. Verifique

A plataforma consulta a marca pelo endereço acessado. Para diagnóstico, a mesma consulta pública, sem autenticação, mostra a quem o domínio pertence:

• applicationEntry indica qual painel o domínio abre: portal ou backoffice.
• 404 significa que nenhum white label responde por esse domínio: ele não foi salvo, foi digitado diferente, a empresa não está ativa ou o domínio está cadastrado em mais de uma empresa.

Esta consulta não faz parte da referência de endpoints e serve só para diagnóstico. Não a use como contrato da sua integração.

Antes de divulgar o endereço, confira:

• o domínio resolve para o destino do CNAME;
• o endereço abre com https:// e sem alerta de certificado;
• a aba do navegador mostra o nome do produto e o favicon da marca;
• logos e ícones abrem, inclusive na tela de acesso;
• um usuário da empresa consegue entrar pelo domínio.

Quem pode entrar

• O domínio atende só a empresa principal dona dele e as subempresas dela.
• Quem é de outra empresa e entra por esse endereço tem a sessão encerrada e é levado ao endereço oficial de acesso.
• Cada endereço tem a própria sessão: quem estava conectado no endereço oficial precisa entrar de novo no domínio próprio.
• A marca depende do endereço, não do usuário. No endereço oficial, todos veem a identidade padrão.

Problemas comuns