Pular para conteúdo

Apps OAuth2 na Gubee

Um app OAuth2 é a forma de um sistema de fora falar com a Gubee em nome de um seller, sem que ninguém precise compartilhar senha ou token permanente. O seller autoriza o app uma vez, e o app passa a receber tokens próprios com acesso ao que foi autorizado — e só a isso.

É o caminho recomendado para ERPs, hubs, emissores de nota, ferramentas de precificação e qualquer sistema de terceiro que precise ler ou escrever dados de um seller.

Quem é quem

Papel Quem é O que faz
Dono do app O seller (ou parceiro) que registrou o app no painel Cadastra o app, guarda as credenciais, desenvolve a integração
Seller que autoriza Qualquer seller que use o app Aprova o acesso e pode revogá-lo quando quiser
Gubee A plataforma Emite os tokens, valida a autorização e mantém o interruptor geral do app

O dono do app e o seller que autoriza não precisam ser o mesmo. Um app registrado por uma empresa de software é usado pelos clientes dela: cada cliente autoriza com a própria conta, e cada um pode revogar sem afetar os outros.

flowchart LR
    D[Dono do app<br/>registra e mantém] -->|publica| A[App OAuth2]
    S[Seller<br/>autoriza o acesso] -->|autoriza| A
    A -->|token do seller| G[API Gubee]
    S -.->|pode revogar<br/>a qualquer momento| A

Ciclo de vida

flowchart TD
    R[1. Registrar<br/>painel: Meus apps] --> C[2. Implementar<br/>fluxo de autorização]
    C --> A[3. Seller autoriza<br/>uma vez]
    A --> U[4. App usa a API<br/>com token próprio]
    U --> V{Continua<br/>autorizado?}
    V -->|Sim| U
    V -->|Seller revoga<br/>ou dono desativa| F[5. Acesso encerrado]
  1. Registrar — o dono cria o app no painel e recebe client_id e client_secret. Detalhes em Criar e gerenciar apps.
  2. Implementar — o desenvolvedor monta o fluxo de autorização e a troca de tokens. Detalhes em Guia do desenvolvedor.
  3. Autorizar — o seller aprova o acesso pelo painel da Gubee.
  4. Usar — o app chama a API de integração com o token que recebeu.
  5. Encerrar — o seller revoga o acesso em "Apps conectados", ou o dono desativa/exclui o app. Ver Apps conectados.

Dois interruptores independentes

Um app só funciona com os dois ligados:

  • O interruptor do dono, na tela do app ("Situação da integração"). Desligado, o app para de emitir e aceitar token, e quem já autorizou fica sem acesso.
  • O interruptor da Gubee. Quando a Gubee desativa um app, o dono não consegue religá-lo pelo painel.

Desativar não é excluir

Desativar é reversível pelo dono e preserva o cadastro e as autorizações. Excluir apaga o app e derruba todas as conexões de forma definitiva.

Por onde seguir