Pular para o conteúdo principal

Consultar White Label

Este documento fornece os endpoints necessários para a consulta de configurações White Label, permitindo a obtenção dos dados de um White Label específico, sua associação a um Corban ou a consulta por meio de um slug único.

Endpoints para Consultar White Label​

1. Consultar White Label por ID​

Consulta as informações detalhadas de um White Label específico utilizando o ID do White Label.

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

Parâmetros de Caminho​

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

Exemplo de Requisição com curl​

curl -X GET https://bff-dev.granatech.com.br/api/whitelabel/a1b2c3d4e5f6

2. Consultar White Label por Corban ID​

Recupera o White Label associado a um Corban específico, utilizando o corbanId.

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/whitelabel/corban/{corbanId}

Parâmetros de Caminho​

  • corbanId (number, obrigatório): O ID do Corban para o qual deseja obter o White Label.

Exemplo de Requisição com curl​

curl -X GET https://bff-dev.granatech.com.br/api/whitelabel/corban/1

3. Consultar White Label por Slug​

Consulta as informações de um White Label utilizando um slug único. Este método é útil para identificar White Labels por uma URL amigável.

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/whitelabel?slug={slug}

Parâmetros de Consulta​

  • slug (string, obrigatório): O slug único para identificar o White Label.

Exemplo de Requisição com curl​

curl -X GET "https://bff-dev.granatech.com.br/api/whitelabel?slug=exemplo-slug"

Observações​

  1. Autenticação Necessária: Os endpoints que utilizam corbanId e id necessitam de autenticação, pois são protegidos pelo sistema.
  2. Slug Único: O slug é um identificador único e amigável ao usuário para acessar o White Label, ideal para personalização de URLs.
  3. Uso do Corban ID: Utilize o Corban ID para associar o White Label a um Corban específico, facilitando a gestão de clientes e suas identidades visuais.

Esses endpoints fornecem a flexibilidade para obter as configurações White Label de várias formas, garantindo acesso completo às informações visuais personalizadas de cada cliente.