Visão geral do SDK White Label

Bem-vindo à documentação do SDK White Label. O SDK White Label é a solução white-label da Getnet para terminais POS Android. Ele permite que seu aplicativo execute fluxos completos de pagamento presencial diretamente no terminal, sem que você lide com o hardware ou com os serviços de pagamento. No código, seu ponto de entrada é a classe ApoloSdk.

O que é o SDK White Label

O SDK White Label é uma biblioteca Android que você incorpora ao seu próprio aplicativo. Depois de integrado, seu aplicativo pode iniciar vendas, estornos e impressão de recibos por um único ponto de entrada: ApoloSdk.Builder.

O SDK cuida de três frentes que, sem ele, exigiriam um esforço considerável da sua parte:

  • Operação do terminal — o SDK controla o hardware do terminal necessário para a transação.
  • Comunicação com os serviços de pagamento — autenticação, autorização, captura e verificações de disponibilidade acontecem dentro do SDK.
  • Fluxos prontos — telas, transições, estados de erro e mensagens ao portador do cartão vêm como um pacote, com pontos de extensão definidos.
O SDK não mantém histórico de transações e não substitui seu backend na conciliação, na emissão fiscal ou nos relatórios. Essas responsabilidades continuam com o seu aplicativo.

Como depende de hardware e serviços que existem só em dispositivos POS, o SDK não roda em emuladores, máquinas virtuais ou celulares Android comuns.

Como funciona

O SDK segue o modelo Single-Activity: todas as telas do fluxo de transação ficam dentro de uma Activity dedicada, hospedada pelo SDK. Seu aplicativo dispara uma operação, o SDK assume a interface e o controle volta para o seu aplicativo quando a operação termina.

Uma integração típica passa por quatro momentos:

  1. Inicialização — você configura o SDK uma única vez, durante a inicialização do seu aplicativo.
  2. Warm-up — o SDK carrega a configuração do terminal e se autentica nos serviços de pagamento, informando o progresso ao seu aplicativo.
  3. Operação — depois que o warm-up é concluído com sucesso, seu aplicativo inicia uma venda, um estorno ou uma impressão.
  4. Resultado — quando o fluxo termina, o SDK retorna um resultado tipado por meio de um callback.

Entre a digitação do valor e o resultado final, o SDK executa toda a transação internamente.

Uma experiência white-label

Cada operação vem com as telas do próprio SDK, que guiam o portador do cartão pela jornada no terminal. Você pode manter as telas prontas ou adaptá-las à sua identidade:

  • Aplique as cores da sua marca pela customização do tema.
  • Insira telas entre as etapas existentes do fluxo.
  • Substitua a aparência de uma tela mantendo o comportamento dela.
  • Personalize os recibos impressos para o estabelecimento e para o cliente.

Assim, a experiência pode ir das telas padrão do SDK até um fluxo totalmente sob medida para o seu aplicativo.

Onde o SDK se encaixa

O SDK White Label roda no terminal, no lado do cliente. Ele depende do serviço de gestão de terminais da Getnet para duas coisas: a configuração que carrega durante o warm-up e as credenciais com que se autentica. Os pagamentos são então processados de forma presencial pelo SEP.

O SDK White Label atende somente terminais POS Android. Ele foi projetado para parceiros que já têm relacionamento com a Getnet e querem aceitar pagamentos pelo próprio aplicativo.

Próximos passos

Para começar a sua integração, siga o caminho abaixo:

  • Pré-requisitos — confirme o ambiente, as credenciais e os serviços do terminal necessários antes de integrar.
  • Adicione o SDK ao seu projeto — configure a dependência, as permissões e os serviços obrigatórios do terminal.
  • Início rápido — inicialize o SDK e execute sua primeira venda.
  • Processe uma venda — execute cada meio de pagamento e modalidade e depois explore estornos, impressão e customização.

Nesta página

Visão geral do SDK White Label