Pular para conteúdo

Criar e gerenciar apps

Todo app OAuth2 começa por um cadastro no painel da Gubee. Quem cadastra é o dono do app: o seller que vai usá-lo na própria operação, ou quem desenvolve um produto para atender outros sellers.

Onde fica

No painel: Integrações → aba Meus apps.

A aba lista os apps que este seller registrou, com a situação de cada um.

Aba Meus apps com os apps registrados pelo seller

Criar um app

Clique em Novo app e preencha o formulário.

Formulário de criação de um app OAuth2

Campo Obrigatório O que informar
Nome do app Sim O nome que o seller vê na hora de autorizar. Use o nome do produto, não um código interno.
Descrição Não Uma frase sobre o que o app faz. Aparece junto do nome no painel.
Categoria Sim Onde o app se encaixa no catálogo de integrações.
URL do logo Não Endereço https de uma imagem. Sem logo, o app aparece com as iniciais do nome.
URIs de redirecionamento Sim Endereço para onde o usuário volta depois de autorizar. Um por campo; use Adicionar URI para mais de um.

Regras das URIs de redirecionamento

A URI é conferida na autorização, e a checagem é rígida de propósito — é ela que impede que uma autorização seja desviada para um endereço que não é seu.

  • Precisa ser https. A única exceção é localhost / 127.0.0.1, para desenvolvimento local.
  • Sem curinga. * é recusado.
  • A comparação é exata. https://meusistema.com/callback e https://meusistema.com/callback/ são endereços diferentes. Cadastre exatamente a URI que o seu sistema vai usar, incluindo barra final e maiúsculas.

A tela do app

Depois de salvar, o app abre com as credenciais e as ações de administração. A mesma tela aparece ao clicar em Gerenciar em qualquer app da aba.

Tela de um app com credenciais, conexões e ações

Bloco Para que serve
Client ID Identificador público do app. Vai na URL de autorização.
Client Secret Credencial secreta do app. Fica oculto; use o olho para revelar e o ícone ao lado para copiar.
URL de callback As URIs de redirecionamento cadastradas.
Sellers conectados Quantos sellers autorizaram este app.
Situação da integração O interruptor do dono.

O client secret é uma senha

Guarde-o no cofre de segredos do seu sistema. Nunca o coloque em código versionado, em aplicativo de celular, em front-end ou em log. Quem tem o secret consegue agir como o seu app.

Trocar o client secret

Rodar secret gera um valor novo e invalida o anterior na hora. Quem estiver usando o secret antigo para de autenticar imediatamente.

Rode o secret quando:

  • ele tiver vazado ou você suspeitar disso;
  • alguém com acesso a ele tiver saído da equipe;
  • houver política de rotação periódica no seu lado.

O novo valor aparece uma vez na tela — copie e atualize a configuração do seu sistema antes de fechar.

Rodar secret não é o mesmo que editar o app

Editar nome, descrição, logo ou URIs não troca o secret: quem já integrou continua autenticando com o mesmo valor.

Ativar e desativar

O interruptor Situação da integração é o controle do dono. Desativado, o app não emite nem aceita token, e quem já autorizou fica sem acesso — sem perder o cadastro nem as autorizações. Reativar devolve o acesso.

Se a Gubee tiver desativado o app, o dono não consegue religá-lo pelo painel.

Cortar as conexões

Revogar todos os sellers corta de uma vez o acesso de todos os sellers que autorizaram o app. A tela informa quantos foram cortados.

Use quando o secret vazar, quando uma versão com defeito estiver em campo, ou quando o app for descontinuado. Cada seller precisa autorizar de novo para voltar a usar.

Excluir

Excluir apaga o app definitivamente e derruba todas as conexões. Não há desfazer, e o client_id não volta. Para uma pausa, prefira desativar.

Editar o cadastro

Editar reabre o formulário. Nome, descrição, logo e URIs podem mudar a qualquer momento.

Mudança no que o app acessa derruba quem já conectou

Alterar o conjunto de permissões de um app já publicado revoga a autorização de todos os sellers conectados — o que eles aprovaram deixou de ser o que o app pede. Cada um precisará autorizar novamente. O painel avisa antes de salvar.