Skip to content

Commit

Permalink
Merge pull request #13 from igorpedrosogn/main
Browse files Browse the repository at this point in the history 
Information corrections
  • Loading branch information
@iigorpedroso
iigorpedroso authored Nov 18, 2021
2 parents 7ff7d25 + 7fa5794 commit c75bec0
Show file tree
Hide file tree
Showing 6 changed files with 259 additions and 54 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/dart.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Dart

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

# Note: This workflow uses the latest stable version of the Dart SDK.
# You can specify other versions if desired, see documentation here:
# https://github.com/dart-lang/setup-dart/blob/main/README.md
# - uses: dart-lang/setup-dart@v1
- uses: dart-lang/setup-dart@9a04e6d73cca37bd455e0608d7e5092f881fd603

- name: Install dependencies
run: dart pub get

# Uncomment this step to verify the use of 'dart format' on each commit.
# - name: Verify formatting
# run: dart format --output=none --set-exit-if-changed .

# Consider passing '--fatal-infos' for slightly stricter analysis.
- name: Analyze project source
run: dart analyze

# Your project will need to have tests in test/ and a dependency on
# package:test for this step to succeed. Note that Flutter projects will
# want to change this to 'flutter test'.
- name: Run tests
run: dart test
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,8 @@
# 1.2.0

- Updated: generation payment token

# 1.2.1

- Updated: listing of all examples
- Updated: bug fix
135 changes: 86 additions & 49 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,40 @@

<h1 align="center">Plugin Gerencianet Flutter</h1>


![SDK Gerencianet for Dart](https://media-exp1.licdn.com/dms/image/C4D1BAQH9taNIaZyh_Q/company-background_10000/0/1603126623964?e=2159024400&v=beta&t=coQC_AK70vTYL3NdvbeIaeYts8nKumNHjvvIGCmq5XA)

# gn-api-sdk-dart
---

[![Pub](https://img.shields.io/pub/v/gerencianet.svg?style=flat-square)](https://pub.dartlang.org/packages/gerencianet)

Plugin em Flutter para integração com a API da Gerencianet.

Ir para:

* [Instalação](#instalação)
* [Começando](#começando)
* [Como obter as credenciais Client_Id e Client_Secret](#como-obter-as-credenciais-client-id-e-client-secret)
* [Como gerar um certificado Pix](#como-gerar-um-certificado-pix)
* [Como converter um certificado Pix](#como-converter-um-certificado-pix)
* [Como cadastrar as chaves Pix](#como-cadastrar-as-chaves-pix)
* [Exemplos](#exemplos)
* [Documentação Adicional](#documentação-adicional)
* [Licença](#licença)

SDK for Gerencianet Pagamentos' API.


## Installation
To use this plugin, add gerencianet as [a dependency in your pubspec.yaml file.](https://flutter.dev/docs/development/packages-and-plugins/using-packages)

## **Instalação**
Para usar este plugin, adicione gerencianet como [uma dependência em seu arquivo pubspec.yaml.](https://flutter.dev/docs/development/packages-and-plugins/using-packages)

## Getting started

Then initialize the plugin preferably in the initState of your widget.



## Começando

Em seguida, inicialize o plugin de preferência no initState do seu widget.


```
Expand Down Expand Up @@ -39,75 +62,89 @@ class _PaymentPageState extends State<PaymentPage> {



## Examples

Example for creating a charge.

```
void createCharge(){
Gerencianet gn = Gerencianet(config);
dynamic body = {
'items': [
{'name': "Product 1", 'value': 1100, 'amount': 2}
],
};
return await gn.call('createCharge', body: body);
}

```

You can check out examples of all of our endpoints in [our repository](https://github.com/gerencianet/gn-api-sdk-dart/tree/master/examples).
## **Como obter as credenciais Client-Id e Client-Secret**

### **Crie uma nova aplicação para usar a API Gerencianet:**
1. Acesse o painel da Gerencianet no menu **API**.
2. No canto esquerdo, clique em **Minhas Aplicações** depois em **Nova Aplicação**.
3. Insira um nome para a aplicação, ative a **API de emissões (Boletos e Carnês)** e **API Pix**, e escolha os escopos que deseja liberar em **Produção** e/ou **Homologação** conforme sua necessidade (lembrando que estes podem ser alterados posteriormente).
4. Clique em Criar **Nova aplicação**.

![Crie uma nova aplicação para usar a API Gerencianet](https://t-images.imgix.net/https%3A%2F%2Fapp-us-east-1.t-cdn.net%2F5fa37ea6b47fe9313cb4c9ca%2Fposts%2F603543ff4253cf5983339cf1%2F603543ff4253cf5983339cf1_88071.png?width=1240&w=1240&auto=format%2Ccompress&ixlib=js-2.3.1&s=2f24c7ea5674dbbea13773b3a0b1e95c)


![Example app](https://s3.amazonaws.com/gerencianet-pub-prod-1/printscreen/2021/06/14/igor.pedroso/0fae57-43bb098d-f9e0-4a0a-b424-4c124ff69450.png)
### **Alterar uma aplicação existente para usar a API Pix:**
1. Acesse o painel da Gerencianet no menu **API**.
2. No canto esquerdo, clique em **Minhas Aplicações**, escolha a sua aplicação e clique no botão **Editar** (Botão laranja).
3. Ative **API Pix** e escolha os escopos que deseja liberar em **Produção** e/ou **Homologação** conforme sua necessidade (lembrando que estes podem ser alterados posteriormente)
4. Clique em **Atualizar aplicação**.

You can also check out our sample Flutter app in [our repository.](https://github.com/gerencianet/gn-api-sdk-flutter-examples)
![Alterar uma aplicação existente para usar a API Pix](https://app-us-east-1.t-cdn.net/5fa37ea6b47fe9313cb4c9ca/posts/603544082060b2e9b88bc717/603544082060b2e9b88bc717_22430.png)


## **Como gerar um certificado Pix**

### If you use the Pix option:
Todas as requisições do Pix devem conter um certificado de segurança que será fornecido pela Gerencianet dentro da sua conta, no formato PFX(.p12). Essa exigência está descrita na íntegra no [manual de segurança do PIX](https://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados).

**To generate your certificate:** Access the menu API (1)-> Meus Certificados (2) and choose the environment you want the certificate: Produção or Homologação -> click in Novo Certificado (3).
![To generate your certificate](https://app-us-east-1.t-cdn.net/5fa37ea6b47fe9313cb4c9ca/posts/603543f7d1778b2d725dea1e/603543f7d1778b2d725dea1e_85669.png)
**Para gerar seu certificado:**
1. Acesse o painel da Gerencianet no menu **API**.
2. No canto esquerdo, clique em **Meus Certificados** e escolha o ambiente em que deseja o certificado: **Produção** ou **Homologação**.
3. Clique em **Novo Certificado**.

**Create a new application to use the Pix API:** Access the menu API (1)-> Minhas Aplicações -> Nova Aplicação(2) -> Ative API Pix (3) and choose the scopes you want to release in Produção e/ou Homologação (remembering that these can be changed later). -> click in Criar Nova aplicação(4).
![Create a new application to use the Pix API](https://t-images.imgix.net/https%3A%2F%2Fapp-us-east-1.t-cdn.net%2F5fa37ea6b47fe9313cb4c9ca%2Fposts%2F603543ff4253cf5983339cf1%2F603543ff4253cf5983339cf1_88071.png?width=1240&w=1240&auto=format%2Ccompress&ixlib=js-2.3.1&s=2f24c7ea5674dbbea13773b3a0b1e95c)
![Para gerar seu certificado](https://app-us-east-1.t-cdn.net/5fa37ea6b47fe9313cb4c9ca/posts/603543f7d1778b2d725dea1e/603543f7d1778b2d725dea1e_85669.png)


**Change an existing application to use the Pix API:** Access the menu API (1)-> Minhas Aplicações e escolha a sua aplicação (2) -> Editar(Botão laranja) -> Ative API Pix (3) and choose the scopes you want to release in Produção e/ou Homologação. -> click in Atualizar aplicação (4).
![Change an existing application to use the Pix API](https://app-us-east-1.t-cdn.net/5fa37ea6b47fe9313cb4c9ca/posts/603544082060b2e9b88bc717/603544082060b2e9b88bc717_22430.png)
## **Como converter um certificado Pix**

⚠️Para uso no Flutter, o certificado deve ser convertido em formato `.pem` e é necessário criar uma chave privada para o certificado.

For use in Dart, the certificate must be converted to .pem.
Below you will find example using the OpenSSL command for conversion.
Você pode [baixar o conversor de certificados disponibilizado pela Gerencianet](https://pix.gerencianet.com.br/ferramentas/conversorGerencianet.exe).

### Command OpenSSL
Ou utilize do exemplo abaixo, executando o comando OpenSSL para conversão.

### **Comando OpenSSL**
```
// Gerar certificado e chave separadas
openssl pkcs12 -in path.p12 -out newfile.crt.pem -clcerts -nokeys //certificado
openssl pkcs12 -in path.p12 -out newfile.key.pem -nocerts -nodes //chave privada
# Gerar certificado e chave separadas
openssl pkcs12 -in path.p12 -out newfile.crt.pem -clcerts -nokeys #certificado
openssl pkcs12 -in path.p12 -out newfile.key.pem -nocerts -nodes #chave privada
```

### To register your Pix keys
The registration of Pix keys can be done through the application. If you don't already have our app installed, click on [Android](https://play.google.com/store/apps/details?id=br.com.gerencianet.app) or [iOS](https://apps.apple.com/br/app/gerencianet/id1443363326), according to your smartphone's operating system, to download it.
## **Como cadastrar as chaves Pix**
O cadastro das chaves Pix pode ser feito através do aplicativo da Gerencianet ou por um endpoint da API. A seguir você encontra os passos de como registrá-las.

### **Cadastrar chave Pix pelo aplicativo mobile:**

Caso ainda não tenha nosso aplicativo instalado, clique em [Android](https://play.google.com/store/apps/details?id=br.com.gerencianet.app) ou [iOS](https://apps.apple.com/br/app/gerencianet/id1443363326), de acordo com o sistema operacional do seu smartphone, para fazer o download.

Para registrar suas chaves Pix por meio do aplicativo:
1. Acesse sua conta através do **app Gerencianet**.
2. No menu lateral, toque em **Pix** para iniciar seu registro.
3. Leia as informações que aparecem na tela e clique em **Registrar Chave**.
Se este não for mais seu primeiro registro, toque em **Minhas Chaves** e depois no ícone (➕).
4. **Selecione os dados** que você vai cadastrar como Chave do Pix e toque em **avançar** – você deve escolher pelo menos 1 das 4 opções de chaves disponíveis (celular, e-mail, CPF e/ou chave aleatória).
5. Após cadastrar as chaves do Pix desejadas, clique em **concluir**.
6. **Pronto! Suas chaves já estão cadastradas com a gente.**





## **Exemplos**

To register your Pix keys through the application:
1. Access your account through **app Gerencianet**.
2. In the side menu, touch **Pix** to start your registration.
3. Read the information that appears on the screen and click **Registrar Chave**.
If this is no longer your first contact, tap **Minhas Chaves** and then the icon (➕).
4. **Select the data** you are going to register as a Pix Key and tap **avançar** - you must choose at least 1 of the 4 available key options (cell, e-mail, CPF e/ou random key).
5. After registering the desired Pix keys, click on **concluir**.
6. **Ready! Your keys are already registered with us.**
Você pode consultar todos os exemplos disponiveis para Flutter, [clicando aqui](https://pub.dev/packages/gerencianet/example).

Também disponibilizamos um projeto em Flutter contendo exemplos de todas as funcionalidades das nossas APIs. Você pode clonar o repositório do projeto, [clique aqui para acessar](https://github.com/gerencianet/gn-api-sdk-flutter-examples).



## Additional Documentation
## **Documentação Adicional**

The full documentation with all available endpoints is in https://dev.gerencianet.com.br/.
A documentação completa com todos os endpoints e detalhes da API está disponível emhttps://dev.gerencianet.com.br/.

If you don't have a digital account atnetnet, [open yours now](https://sistema.gerencianet.com.br/)!

## License ##
## **Licença**
[MIT](LICENSE)
Loading

0 comments on commit c75bec0

Please sign in to comment.