White Label
Resumo
A API de White Label é um serviço da GoTokens utilizada para a parametrização da loja e personalização das diferentes interfaces disponívies no sistema através da gestão de templates, é possível personalizar o Painel Administrativo, Loja e App.
Como funciona
O cliente deve passar como parâmetro suas credenciais de usuário e caso ela esteja ativo e possua o serviço de White Label da GoBlockchain ele poderá definir parâmetros da loja e listar, criar, editar e excluir templates.
O que são Temas?
São Layouts disponibilizados pela GoBlockchain para serem usado como base do template.
O que são Templates?
São personalizaçẽos criadas pela empresa, possuem o código do tema a ser usado e as variáveis de personalizações, pode-se criar multiplos templates com o mesmo tema e personalizações diferentes ou multiplos templates com themas diferentes. *Podem serem usados em datas comemorativas por exemplo.
Configurações
As configurações armazenam dados usados no preenchimento e montagem das telas, dados como links de redes sociais, meios de pagamento aceitos, logotipo, cores principais, etc. Estão diretamente no objeto settings, após a empresa finalizar a configuração inicial o white label já está pronto para operar com uma Loja Padrão.
Templates
A criação de templates é um processo separado, a empresa deverá escolher o tema para o template que está criando e personalizar para web e mobile, depois a empresa poderá atribuir esse template a uma Company (todas as comunidades da emrpesa passam a usar esse template como padrão) e/ou Comunidade (caso queria usar templates distintos em diferentes comunidades)
O Objeto template recebe dados de personalização separados em header/page/card/footer e são utilizados em Cascata, ou seja o frontend da loja dará preferência para as variáveis seguindo a seguinte hierarquia de prioridades: Template da Comunidades, Template da Empresa, e Default (caso não configure no template)
Objeto Settings
Objeto Template
Endpoints
Configurações
GET /v1/white-label/settings/:companyId
PATCH /v1/white-label/settings/:companyId
Templates
POST /v1/white-label/templates
GET /v1/white-label/templates
GET /v1/white-label/templates/:templateId
PATCH /v1/white-label/tempaltes/:templateId
DELETE /v1/white-label/templates/:templateId
Atribuição de templates
POST /v1/white-label/templates/community/:communityId
Configurações
Configurações da empresa
GET
https://goblockchain.io/gotokens-api/v1/white-label/settings/:companyId
Nível de autorização necessário: público
Path Parameters
Name | Type | Description |
---|---|---|
companyId* | String | ID da empresa |
(JWT) Altera configurações da empresa
PATCH
https://goblockchain.io/gotokens-api/v1/white-label/settings/:companyId
Nível de autorização necessário: company_admin
Path Parameters
Name | Type | Description |
---|---|---|
companyId* | String |
Headers
Name | Type | Description |
---|---|---|
authorization* | Bearer | JWT |
Request Body
Name | Type | Description |
---|---|---|
title* | String | Título da empresa |
description | String | Descrição da empresa |
termsAndConditions | String | Termos e condições da empresa |
privacyPolicy | String | Política de privacidade da empresa |
supportEmail | String | Email de suporte da empresa |
supportUrl | String | Url de suporte da empresa |
googleAnalyticsId | String | Identificador do Google Analytics |
logo | String | Logo da empresa |
socialLoginActive | String | Status do login social |
socialLogin | String | Lista de logins sociais integrados |
walletProviders | Array | Lista de provedores de wallets integrados |
socialLinks | Object | Redes sociais da empresa |
secondaryColor | String | Cor secundária da empresa |
mainColor | String | Cor principal da empresa |
GTMTrackinID | String | Identificador do Google Tag Manager |
defaultTheme | String | Thema padrão utilizado quando nenhum template e definido |
Templates
(JWT) Cria um template com as informações enviadas
POST
https://goblockchain.io/gotokens-api/v1/white-label/templates
Nível de autorização necessário: company_admin
Headers
Name | Type | Description |
---|---|---|
authorization* | Bearer | JWT |
Request Body
Name | Type | Description |
---|---|---|
mobile* | Object | Personalização do ambiente mobile |
web* | Object | Personalização do ambiente web |
companyId* | String | ID da empresa onde será usado o template |
(JWT) Lista de templates da empresa
GET
https://goblockchain.io/gotokens-api/v1/white-label/templates
Nível de autorização necessário: company_admin
Query Parameters
Name | Type | Description |
---|---|---|
limit | String | Limite de resultados na busca |
offset | String | Quantidade de resultados para avançar da busca |
companyId | String | ID da Empresa |