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

Exemplo de Objeto de Configurações

{
  "companyId": "",
  "title": "StockCar",
  "description": "StockCar is a decentralized platform for trading and investing in sports cars.",
  "termsAndConditions": "https://stockcar.io/terms-and-conditions",
  "privacyPolicy": "https://stockcar.io/privacy-policy",
  "supportEmail": "",
  "supportUrl": "https://stockcar.io/contact-us",
  "googleAnalyticsId": "",
  "GTMTrackinID": "GTM-NSBFS33",
  "logo": "https://stockcar.io/assets/img/logo.png",
  "mainColor": "#e0c160",
  "secondaryColor": "#e0c160",
  "theme": "default",
  "websiteUrl": "https://www.stockproseries.com.br",
  "twitterUrl": "https://twitter.com/stock_car?lang=en",
  "facebookUrl": "https://www.facebook.com/stockcaroficial",
  "instagramUrl": "https://www.instagram.com/stock_car/?hl=en",
  "youtubeUrl": "https://www.youtube.com/user/stockcarchannel",
  "telegramUrl": "https://t.me/+pmcn19QEC2s0ZWIx"
  "walletProviders": ["metamask"],
  "socialLogin": ["google", "facebook"],
  "socialLoginActive": true
}

Objeto Template

Exemplo de Objeto de Template

{
  "id": "123123",
  "companyId": "1234234234",
  "web": {
    "theme": "default",
    "mainColorLight": "#e0c160",
    "secondaryColorLight": "#e0c160",
    "mainColorDark": "#e0c160",
    "secondaryColorDark": "#e0c160",
    "header": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ],
      "logo": {
        "url": "https://i.imgur.com/mWkGKDB.jpeg",
        "width": "100px",
        "height": "100px",
        "position": "left"
      }
    },
    "footer": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ],
      "logo": {
        "url": "https://i.imgur.com/mWkGKDB.jpeg",
        "width": "100px",
        "height": "100px",
        "position": "left"
      }
    },
    "page": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ]
    },
    "card": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ]
    }
  },
  "mobile": {}
}

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

200: OK

Exemplo de Resposta

{
  "companyId": "",
  "title": "StockCar",
  "description": "StockCar is a decentralized platform for trading and investing in sports cars.",
  "termsAndConditions": "https://stockcar.io/terms-and-conditions",
  "privacyPolicy": "https://stockcar.io/privacy-policy",
  "supportEmail": "",
  "supportUrl": "https://stockcar.io/contact-us",
  "googleAnalyticsId": "",
  "GTMTrackinID": "GTM-NSBFS33", 
  "logo": "https://stockcar.io/assets/img/logo.png",
  "mainColor": "#e0c160",
  "secondaryColor": "#e0c160",
  "defaultTheme": "default",
  "socialLinks": {
    "websiteUrl": "https://www.stockproseries.com.br",
    "twitterUrl": "https://twitter.com/stock_car?lang=en",
    "facebookUrl": "https://www.facebook.com/stockcaroficial",
    "instagramUrl": "https://www.instagram.com/stock_car/?hl=en",
    "youtubeUrl": "https://www.youtube.com/user/stockcarchannel",
    "telegramUrl": "https://t.me/+pmcn19QEC2s0ZWIx"
  },
  "walletProviders": ["metamask"],
  "socialLogin": ["google", "facebook"],
  "socialLoginActive": true
}

Campos da Resposta

• companyId - String Identificador da empresa

• 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

• GTMTrackinID - String Identificador do Google Tag Manager

• logo - String Logo da empresa

• mainColor - String Cor principal da empresa

• secondaryColor - String Cor secundária da empresa

• defaultThema- String Thema padrão utilizado quando nenhum template e definido

• socialLinks - Object Redes sociais da empresa

  • websiteUrl - String Url do site da empresa

  • twitterUrl - String Url do twitter da empresa

  • facebookUrl - String Url do facebook da empresa

  • instagramUrl - String Url do instagram da empresa

  • youtubeUrl - String Url do youtube da empresa

  • telegramUrl - String Url do telegram da empresa

• walletProviders -Array <String> Provedores de carteira

• socialLogin - Array<String> Login social

• socialLoginActive - bool Login social ativo

(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

200: OK

Exemplo de Resposta

{
  "companyId": "",
  "title": "StockCar",
  "description": "StockCar is a decentralized platform for trading and investing in sports cars.",
  "termsAndConditions": "https://stockcar.io/terms-and-conditions",
  "privacyPolicy": "https://stockcar.io/privacy-policy",
  "supportEmail": "",
  "supportUrl": "https://stockcar.io/contact-us",
  "googleAnalyticsId": "",
  "GTMTrackinID": "GTM-NSBFS33", 
  "logo": "https://stockcar.io/assets/img/logo.png",
  "mainColor": "#e0c160",
  "secondaryColor": "#e0c160",
  "defaultTheme": "default",
  "socialLinks": {
    "websiteUrl": "https://www.stockproseries.com.br",
    "twitterUrl": "https://twitter.com/stock_car?lang=en",
    "facebookUrl": "https://www.facebook.com/stockcaroficial",
    "instagramUrl": "https://www.instagram.com/stock_car/?hl=en",
    "youtubeUrl": "https://www.youtube.com/user/stockcarchannel",
    "telegramUrl": "https://t.me/+pmcn19QEC2s0ZWIx"
  },
  "walletProviders": ["metamask"],
  "socialLogin": ["google", "facebook"],
  "socialLoginActive": true
}

Campos da Resposta

• companyId - String Identificador da empresa

• 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

• GTMTrackinID - String Identificador do Google Tag Manager

• logo - String Logo da empresa

• mainColor - String Cor principal da empresa

• secondaryColor - String Cor secundária da empresa

• defaultThema- String Thema padrão utilizado quando nenhum template e definido

• socialLinks - Object Redes sociais da empresa

  • websiteUrl - String Url do site da empresa

  • twitterUrl - String Url do twitter da empresa

  • facebookUrl - String Url do facebook da empresa

  • instagramUrl - String Url do instagram da empresa

  • youtubeUrl - String Url do youtube da empresa

  • telegramUrl - String Url do telegram da empresa

• walletProviders -Array <String> Provedores de carteira

• socialLogin - Array<String> Login social

• socialLoginActive - bool Login social ativo

400: Bad Request

401: Unauthorized

Possíveis Erros HTTP - 401

Código	Descrição
1	Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

403: Forbidden

Possíveis Erros HTTP - 403

Código	Descrição
1	Acesso restrito ao recurso.
10	Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

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

201: Created

Exemplo de Resposta

{
  "id": "123123",
  "companyId": "1234234234",
  "mobile": {
    "theme": "default",
    "mainColorLight": "#e0c160",
    "secondaryColorLight": "#e0c160",
    "mainColorDark": "#e0c160",
    "secondaryColorDark": "#e0c160",
    "header": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ],
      "logo": {
        "url": "https://i.imgur.com/mWkGKDB.jpeg",
        "width": "100px",
        "height": "100px",
        "position": "left"
      }
    },
    "footer": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ],
      "logo": {
        "url": "https://i.imgur.com/mWkGKDB.jpeg",
        "width": "100px",
        "height": "100px",
        "position": "left"
      }
    },
    "page": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ]
    },
    "card": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ]
    }
  },
  "web": {}
}

Campos da Resposta

• id - String

  Identificador próprio do template.

• companyId - String

  Identificador da empresa

• mobile - String

  Personalização do ambiente Mobile.

• web - String

  Personalização do ambiente Web.

400: Bad Request

401: Unauthorized

Possíveis Erros HTTP - 401

Código	Descrição
1	Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

403: Forbidden

Possíveis Erros HTTP - 403

Código	Descrição
1	Acesso restrito ao recurso.
10	Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

(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

200: OK

Exemplo de Resposta

{
  "templates": [
    {
      "mobile": {
        "theme": "default",
        "mainColorLight": "#e0c160",
        "secondaryColorLight": "#e0c160",
        "mainColorDark": "#e0c160",
        "secondaryColorDark": "#e0c160",
        "header": {
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "titles": [
            {
              "tag": "h1",
              "color": "#ffffff",
              "font": "Arial",
              "style": "bold",
              "size": "24px"
            },
            {
              "tag": "h2",
              "color": "#ffffff",
              "font": "Arial",
              "style": "bold",
              "size": "18px"
            }
          ],
          "text": {
            "color": "#ffffff",
            "font": "Arial",
            "style": "bold",
            "size": "12px"
          },
          "buttons": [
            {
              "name": "primary",
              "type": "circle",
              "backgroundColor": "#1a1a1a",
              "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
              "icon": "fa fa-lightbulb-o",
              "iconPosition": "left",
              "borderColor": "#ffffff",
              "borderEffect": "none",
              "color": "#ffffff",
              "font": "Arial",
              "size": "12px",
              "style": "bold",
              "hover": {
                "borderColor": "#ffffff",
                "borderEffect": "none",
                "backgroundColor": "#1a1a1a",
                "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
                "color": "#ffffff",
                "font": "Arial",
                "size": "12px",
                "style": "bold"
              }
            }
          ],
          "logo": {
            "url": "https://i.imgur.com/mWkGKDB.jpeg",
            "width": "100px",
            "height": "100px",
            "position": "left"
          }
        },
        "footer": {
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "titles": [
            {
              "tag": "h1",
              "color": "#ffffff",
              "font": "Arial",
              "style": "bold",
              "size": "24px"
            },
            {
              "tag": "h2",
              "color": "#ffffff",
              "font": "Arial",
              "style": "bold",
              "size": "18px"
            }
          ],
          "text": {
            "color": "#ffffff",
            "font": "Arial",
            "style": "bold",
            "size": "12px"
          },
          "buttons": [
            {
              "name": "primary",
              "type": "circle",
              "backgroundColor": "#1a1a1a",
              "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
              "icon": "fa fa-lightbulb-o",
              "iconPosition": "left",
              "borderColor": "#ffffff",
              "borderEffect": "none",
              "color": "#ffffff",
              "font": "Arial",
              "size": "12px",
              "style": "bold",
              "hover": {
                "borderColor": "#ffffff",
                "borderEffect": "none",
                "backgroundColor": "#1a1a1a",
                "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
                "color": "#ffffff",
                "font": "Arial",
                "size": "12px",
                "style": "bold"
              }
            }
          ],
          "logo": {
            "url": "https://i.imgur.com/mWkGKDB.jpeg",
            "width": "100px",
            "height": "100px",
            "position": "left"
          }
        },
        "page": {
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "titles": [
            {
              "tag": "h1",
              "color": "#ffffff",
              "font": "Arial",
              "style": "bold",
              "size": "24px"
            },
            {
              "tag": "h2",
              "color": "#ffffff",
              "font": "Arial",
              "style": "bold",
              "size": "18px"
            }
          ],
          "text": {
            "color": "#ffffff",
            "font": "Arial",
            "style": "bold",
            "size": "12px"
          },
          "buttons": [
            {
              "name": "primary",
              "type": "circle",
              "backgroundColor": "#1a1a1a",
              "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
              "icon": "fa fa-lightbulb-o",
              "iconPosition": "left",
              "borderColor": "#ffffff",
              "borderEffect": "none",
              "color": "#ffffff",
              "font": "Arial",
              "size": "12px",
              "style": "bold",
              "hover": {
                "borderColor": "#ffffff",
                "borderEffect": "none",
                "backgroundColor": "#1a1a1a",
                "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
                "color": "#ffffff",
                "font": "Arial",
                "size": "12px",
                "style": "bold"
              }
            }
          ]
        },
        "card": {
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "titles": [
            {
              "tag": "h1",
              "color": "#ffffff",
              "font": "Arial",
              "style": "bold",
              "size": "24px"
            },
            {
              "tag": "h2",
              "color": "#ffffff",
              "font": "Arial",
              "style": "bold",
              "size": "18px"
            }
          ],
          "text": {
            "color": "#ffffff",
            "font": "Arial",
            "style": "bold",
            "size": "12px"
          },
          "buttons": [
            {
              "name": "primary",
              "type": "circle",
              "backgroundColor": "#1a1a1a",
              "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
              "icon": "fa fa-lightbulb-o",
              "iconPosition": "left",
              "borderColor": "#ffffff",
              "borderEffect": "none",
              "color": "#ffffff",
              "font": "Arial",
              "size": "12px",
              "style": "bold",
              "hover": {
                "borderColor": "#ffffff",
                "borderEffect": "none",
                "backgroundColor": "#1a1a1a",
                "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
                "color": "#ffffff",
                "font": "Arial",
                "size": "12px",
                "style": "bold"
              }
            }
          ]
        }
      },
      "web": {
        /* mesmo padrão do mobile */
      }
    }
  ]
}

Campos da Resposta

• templates - Array of Objects

  Armazena as informações de cada template da empresa solicitada.

  • id - String

    Identificador próprio do template.

  • mobile - String

    Personalização do ambiente Mobile.

  • web - String

    Personalização do ambiente Web.

Detalhes do template

GET https://goblockchain.io/gotokens-api/v1/white-label/templates/:templateId

Nível de autorização necessário: qualquer

Path Parameters

Name	Type	Description
templateId*	String	Id do template

200: OK

Exemplo de Resposta

{
  "id": "1234124",
  "companyId": "123123",
  "mobile": {
    "theme": "default",
    "mainColorLight": "#e0c160",
    "secondaryColorLight": "#e0c160",
    "mainColorDark": "#e0c160",
    "secondaryColorDark": "#e0c160",
    "header": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ],
      "logo": {
        "url": "https://i.imgur.com/mWkGKDB.jpeg",
        "width": "100px",
        "height": "100px",
        "position": "left"
      }
    },
    "footer": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ],
      "logo": {
        "url": "https://i.imgur.com/mWkGKDB.jpeg",
        "width": "100px",
        "height": "100px",
        "position": "left"
      }
    },
    "page": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ]
    },
    "card": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ]
    }
  },
  "web": {
    /* mesmo padrão do mobile */
  }
}

Campos da Resposta

• id - String

  Identificador próprio do template.

• companyId - String

  Identificador da empresa

• mobile - String

  Personalização do ambiente Mobile.

• web - String

  Personalização do ambiente Web.

(JWT) Atualiza um template com as informações enviadas

PATCH https://goblockchain.io/gotokens-api/v1/white-label/templates/:templateId

Nível de permissionamento necessário: company_admin

Path Parameters

Name	Type	Description
templateId*	String	ID do Template

Request Body

Name	Type	Description
mobile	Object	Personalização do ambiente mobile
web	Array	Personalização do ambiente web
companyId	Object	Identificador da empresa

200: OK

Exemplo de Resposta

{
  "id": "1234",
  "companyId": "123",
  "mobile": {
    "theme": "default",
    "mainColorLight": "#e0c160",
    "secondaryColorLight": "#e0c160",
    "mainColorDark": "#e0c160",
    "secondaryColorDark": "#e0c160",
    "header": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ],
      "logo": {
        "url": "https://i.imgur.com/mWkGKDB.jpeg",
        "width": "100px",
        "height": "100px",
        "position": "left"
      }
    },
    "footer": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ],
      "logo": {
        "url": "https://i.imgur.com/mWkGKDB.jpeg",
        "width": "100px",
        "height": "100px",
        "position": "left"
      }
    },
    "page": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ]
    },
    "card": {
      "backgroundColor": "#1a1a1a",
      "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
      "titles": [
        {
          "tag": "h1",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "24px"
        },
        {
          "tag": "h2",
          "color": "#ffffff",
          "font": "Arial",
          "style": "bold",
          "size": "18px"
        }
      ],
      "text": {
        "color": "#ffffff",
        "font": "Arial",
        "style": "bold",
        "size": "12px"
      },
      "buttons": [
        {
          "name": "primary",
          "type": "circle",
          "backgroundColor": "#1a1a1a",
          "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
          "icon": "fa fa-lightbulb-o",
          "iconPosition": "left",
          "borderColor": "#ffffff",
          "borderEffect": "none",
          "color": "#ffffff",
          "font": "Arial",
          "size": "12px",
          "style": "bold",
          "hover": {
            "borderColor": "#ffffff",
            "borderEffect": "none",
            "backgroundColor": "#1a1a1a",
            "backgroundUrl": "https://i.imgur.com/mWkGKDB.jpeg",
            "color": "#ffffff",
            "font": "Arial",
            "size": "12px",
            "style": "bold"
          }
        }
      ]
    }
  },
  "web": {
    /* mesmo padrão do mobile */
  }
}

Campos da Resposta

• id - String

  Identificador próprio do template.

• companyId - String

  Identificador da empresa

• mobile - String

  Personalização do ambiente Mobile.

• web - String

  Personalização do ambiente Web.

400: Bad Request

403: Forbidden

Possíveis Erros HTTP - 403

Código	Descrição
1	Acesso restrito ao recurso.
10	Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

401: Unauthorized

Possíveis Erros HTTP - 401

Código	Descrição
1	Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

(JWT) Remove um template

DELETE https://goblockchain.io/gotokens-api/v1/white-label/templates/:templateId

Nível de autorização necessário: company_admin

Path Parameters

Name	Type	Description
templateId*	String	ID fo Template

Headers

Name	Type	Description
authorization*	Bearer	JWT

204: No Content

400: Bad Request

Possíveis Erros HTTP - 400

Código	Descrição
1001	Parâmetro "id" inválido. O campo é obrigatório e deve ser do tipo String.

401: Unauthorized

Possíveis Erros HTTP - 401

Código	Descrição
1	Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

403: Forbidden

Possíveis Erros HTTP - 403

Código	Descrição
1	Acesso restrito ao recurso.
10	Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

Atribuição de Templates

(JWT) Atribui um template a uma comunidade especifica da empresa

POST https://goblockchain.io/gotokens-api/v1/white-label/templates/community/:communityId

Nível de autorização necessário: company_admin

Path Parameters

Name	Type	Description
communityId*	String	ID da Comunidade

Headers

Name	Type	Description
authorization*	Bearer	JWT

Request Body

Name	Type	Description
templateId*	String	ID do template

204: No Content

401: Unauthorized

Possíveis Erros HTTP - 401

Código	Descrição
1	Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

403: Forbidden

Possíveis Erros HTTP - 403

Código	Descrição
1	Acesso restrito ao recurso.
10	Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.