Guide PlugPag - Android

Esta página irá apresentar como iniciar o processo de integração dos terminais Minizinha, Moderninha PRO e WIFI com o sistema operacional Android, e ao final disponibiliza Apps Demo para este sistema. Esta apresentação está dividida em duas partes, sendo a primeira a respeito do terminal Minizinha e a segunda dos terminais Moderninha PRO e WIFI.
Clique aquipara ser direcionado à seção dos terminais Moderninha PRO e WIFI.

Os terminais disponíveis para a integração com Android são as versões Minizinha, Moderninha PRO e WIFI, terminais PagBank de pagamento GPRS/3G, sem fio, que aceita cartões de crédito e débito, e integrações com tecnologia com Wi-Fi, Bluetooth e NFC. Permite fácil integração com os sistemas de automação comercial em várias plataformas.

Já se você possui uma aplicação Android, esta integração permite que a sua aplicação se conecte via Bluetooth ao terminal do PagBank, possibilitando ações como Solicitação de Pagamentos, obtenção dos dados de retorno e solicitação de estorno de transações.

📘

Observações

A biblioteca PlugPag possui suporte para API level 16 (4.1 Jelly Bean) à 26 (8.0 Oreo)
Não é possível fazer chamadas da biblioteca caso o usuário tenha permissões de root no aparelho por motivos de segurança.

Minizinha

A Minizinha é um terminal PagBank, leitor de pagamento sem fio, que aceita cartões de crédito e débito, e integrações com tecnologia Bluetooth. Permite fácil integração com os sistemas de automação comercial em várias plataformas.

Esta seção irá apresentar como iniciar a integração PlugPag do terminal Minizinha com o sistema operacional Android, como importar a biblioteca PlugPag e suas principais classes, as permissões necessárias e o App demo para Android.

Importando a biblioteca

Todas as chamadas que você verá nos próximos passos são efetuadas utilizando uma biblioteca exclusiva para Android, que deverá ser importada em seu projeto.

Primeiramente é necessário configurar o repositório da biblioteca no arquivo build.gradle localizado na raiz do projeto. Nele adicione as linhas destacadas abaixo.

repositories {
       ...
       maven {
            url 'https://github.com/pagseguromaster/plugpag/raw/master/3.x/android'
       }
       ...
}

Em seguida inclua a linha abaixo no arquivo build.gradle do módulo de seu projeto.

dependencies {
  ...
   implementation 'com.android.support:design:27.1.0'
   implementation 'br.com.uol.pagseguro:plugpag:3.0.0'
   ...
}

Permissões

Para integrar com a biblioteca PlugPag é necessário adicionar algumas permissões no arquivo AndroidManifest.xml.

Permissões obrigatórias

As permissões obrigatórias são necessárias para o funcionamento correto da integração, permitindo o acesso à configurações de internet e bluetooth, leitura e escrita na memória, e estado do dispositivo.

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.BLUETOOTH"/>
<uses-permission android:name="android.permission.READ_PHONE_STATE"/>

Permissões opcionais

As permissões opcionais permitem à biblioteca obter coordenadas no momento da transação. Essas coordenadas são enviadas aos servidores do PagBank e ajudam a melhorar nossos serviços.

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

Activity

Algumas funcionalidades da biblioteca PlugPag necessitam que uma Activity seja iniciada, através a inclusão do código abaixo.

<application ...>
  ...
  <activity
    android:name="br.com.uol.pagseguro.plugpag.PlugPagActivity" />
 ...
</application>

Classes

A biblioteca PlugPag é composta de um conjunto de classes. A classe principal chama-se PlugPag, mas é necessário utilizar classes auxiliares para configurações e trocas de informações.

Segue abaixo uma lista com classes que compõe a biblioteca.

📘

Documentação

• Para mais detalhes você pode baixar a documentação completa

Demo PlugPag Android

Para facilitar o processo de entendimento sobre o PlugPag, a PagBank disponibiliza apps Demo que trás as principais chamadas existente na biblioteca PlugPag.

• Minizinha - Java

Moderninha WIFI e Moderninha Pro

Esta seção irá apresentar como iniciar a integração PlugPag dos terminais Moderninha PRO e WIFI com o sistema operacional Android, como importar a biblioteca PlugPag e suas principais classes, as permissões necessárias e o App demo para Android.

Importando a biblioteca

Todas as chamadas que você verá nos próximos passos são efetuadas utilizando uma biblioteca exclusiva para Android, que deverá ser importada em seu projeto.

Primeiramente é necessário configurar o repositório da biblioteca no arquivo build.gradle localizado na raiz do projeto. Nele adicione as linhas destacadas abaixo.

repositories {
       jcenter()
       maven {
            url 'https://github.com/pagseguromaster/plugpag/raw/master/android'
       }
}

Em seguida inclua a linha abaixo no arquivo build.gradle do módulo de seu projeto.

dependencies {
    ...
    compile 'br.uol.pagseguro.client:btserial:1.1.0'
    compile 'br.uol.pagseguro.client:plugpag:1.1.0'
    ...
}

Também é importante informar que esta biblioteca não necessita de nenhum tipo de autenticação com login e senha pois o terminal já está autenticada e vinculada a uma conta PagBank.

Dados

Confira no exemplo abaixo os dados que podem ser transmitidos pelo seu terminal PagBank.

public class PlugPag {

   public static final int RET_OK;
   public static final int BUFF_SIZE;
   public static final int NULL_PTR;
   public static final int POS_NOT_READY;
   public static final int TRANS_DENIED;
   public static final int DATA_INV_RESULT_MESSAGE;
   public static final int INV_AMOUNT_PARAM;
   public static final int INV_TOT_AMOUNT_PARAM;
   public static final int INV_USER_REF_PARAM;
   public static final int INV_TRS_RESULT_PARAM;
   public static final int DRIVER_NOT_FOUND;
   public static final int DRIVER_FUNCTION_ERROR;
   public static final int JNI_EXIT_EXCEPTION;

   public static final int CREDIT = 1;
   public static final int DEBIT = 2;
   public static final int VOUCHER = 3;

   public static final int A_VISTA = 1;
   public static final int PARC_VENDEDOR = 2;
}

Demo PlugPag Android

Para facilitar o processo de entendimento sobre o PlugPag, a PagBank disponibiliza apps Demo que trás as principais chamadas existente na biblioteca PlugPag.

Moderninha PRO - Java

Moderninha WIFI - Java