payment-token-efi 3.1.1 → 3.2.0

package/CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+[Release 3.2.0](https://github.com/efipay/js-payment-token-efi/releases/tag/3.2.0) (2025-06-24)
+----------------------------------------------------------------------------------------------
+* Adicionado função de verificação de bloqueio do script de fingerprint
+
+[Release 3.1.2](https://github.com/efipay/js-payment-token-efi/releases/tag/3.1.2) (2025-03-04)
+----------------------------------------------------------------------------------------------
+* Atualização para as rotas Efí
+
 [Release 3.1.1](https://github.com/efipay/js-payment-token-efi/releases/tag/3.1.1) (2025-01-28)
 ----------------------------------------------------------------------------------------------
 * Adicionado validação se o ambiente possui DOM

package/README.md

@@ -11,13 +11,15 @@ Esta biblioteca JavaScript permite uma solução segura e eficiente para manipul
   	- [**UMD**](#universal-module-definition-umd)
   	- [**ES Modules**](#ecmascript-modules-esm)
   	- [**CommonJS**](#commonjs-cjs)
+  - [**Framework React Native e outros (WebView)**](#framework-react-native-e-outros-webview)
   - [**Tipagens TypeScript**](#tipagens-typescript)
 - [**Utilização**](#utilização)
+	- [**Exemplos práticos**](#exemplos-práticos)
+	- [**Verificar bloqueio do script**](#verificar-bloqueio-do-script)
 	- [**Identificar a bandeira**](#identificar-a-bandeira)
 	- [**Buscar as informações de parcelamento**](#buscar-as-informações-de-parcelamento)
 	- [**Gerar o payment_token e card_mask**](#gerar-o-payment_token-e-card_mask)
 	- [**Dados de saída em caso de falha**](#dados-de-saída-em-caso-de-falha)
-	- [**Exemplos práticos**](#exemplos-práticos)
 - [**Criação da cobrança**](#criação-da-cobrança)
 - [**Documentação Adicional**](#documentação-adicional)
 - [**Comunidade e suporte**](#comunidade-e-suporte)
@@ -88,9 +90,9 @@ const EfiPay = require("payment-token-efi");
 ```
 _**Obs**: Esta biblioteca não é compatível no backend em Node.js_
 
-### **Frameworks com WebView (React Native e outros)**
+### **Framework React Native e outros (WebView)**
 
-Para aplicações que não possuem DOM nativo, como React Native, Ionic, Swift,  e outros frameworks similares, é necessário utilizar um componente WebView para executar a biblioteca. O WebView permite que a biblioteca funcione corretamente, pois fornece um ambiente DOM para sua execução. [Disponibilizamos aqui](https://raw.githubusercontent.com/efipay/js-payment-token-efi/main/examples/webview-react-native.js) um exemplo de demonstração com React Native.
+Para aplicações que não possuem DOM nativo, como React Native, Ionic, Swift,  e outros frameworks similares, é necessário utilizar um componente WebView para executar a biblioteca. O WebView permite que a biblioteca funcione corretamente, pois fornece um ambiente DOM para sua execução. [Disponibilizamos aqui](https://github.com/efipay/js-payment-token-efi/blob/main/examples/webview-react-native.js) um exemplo de demonstração com React Native.
 
 ### **Tipagens TypeScript**
 
@@ -100,15 +102,44 @@ Se você estiver utilizando TypeScript, quando você instalar a biblioteca **pay
 
 ## **Utilização**
 
-Este script oferece três funções para manipulação de dados de cartão de crédito. A primeira função permite <ins>**identificar a bandeira**</ins> do cartão a partir do seu número. A segunda função <ins>**busca informações de parcelamento**</ins> de acordo com as configurações de recebimento em sua conta. Por fim, a terceira função <ins>**gera o token de pagamento (payment_token) e a máscara do cartão (card_mask)**</ins> com base nos dados do cartão.
+Este script oferece três funções para manipulação de dados de cartão de crédito. A primeira função permite <ins>**[identificar a bandeira](#identificar-a-bandeira)**</ins> do cartão a partir do seu número. A segunda função <ins>**[busca informações de parcelamento](#buscar-as-informações-de-parcelamento)**</ins> de acordo com as configurações de recebimento em sua conta. Por fim, a terceira função <ins>**[gera o token de pagamento (payment_token) e a máscara do cartão (card_mask)](#gerar-o-payment_token-e-card_mask)**</ins> com base nos dados do cartão.
+
+Para utilizar esse script, é necessário passar o código **Identificador de Conta** (payee_code) como parâmetro para gerar o payment_token dos dados do cartão de crédito. Você pode obter essa informação em sua conta digital (<a href='https://s3.amazonaws.com/gerencianet-pub-prod-1/printscreen/2023/03/08/matheus.rodrigues/24fa15-dda30019-a643-409e-8813-c7cc68adcc40.png' target='_blank'>veja onde encontrar</a>), no menu `API > Introdução > Identificador de Conta`. 
+
+
+### Exemplos práticos
+Disponibilizamos alguns exemplos de utilização para as principais linguaguagens de progração front-end. [Acesse aqui](https://github.com/efipay/js-payment-token-efi/tree/main/examples).
+
+
+### **Verificar bloqueio do script**
+
+A função `isScriptBlocked()` verifica se o script de fingerprint, que ajuda a manter a segurança da transação ao coletar informações do pagador, está sendo bloqueado por alguma extensão ou configuração do navegador. A recomendação é executar essa função logo que a página de checkout carregar, assim é possível já identificar se houve bloqueio antes do cliente tentar fazer o pagamento.
+
+- **Exemplo:**
 
-Para utilizar esse script, é necessário passar o código **Identificador de Conta** (payee_code) como parâmetro para gerar o payment_token dos dados do cartão de crédito. Você pode obter essa informação em sua conta digital, no menu `API > Introdução > Identificador de Conta`. <a href='https://s3.amazonaws.com/gerencianet-pub-prod-1/printscreen/2023/03/08/matheus.rodrigues/24fa15-dda30019-a643-409e-8813-c7cc68adcc40.png' target='_blank'>Veja onde encontrar</a>. 
+  ```js
+  async function checkScriptBlocking() {
+    const isBlocked = await EfiPay.CreditCard.isScriptBlocked();
+
+    if (isBlocked) {
+      console.log("O script está bloqueado!");
+    } else {
+      console.log("O script não está bloqueado.");
+    }
+  }
+  ```
+
+- **Dados de saída:**
 
-Neste repositório, você encontra exemplos para usar a biblioteca. Confira esses exemplos [clicando aqui](https://github.com/efipay/js-payment-token-efi/tree/main/examples).
+  | Descrição                                                                    | Tipo    |
+  | ------------------------------------------------------------------------- | ------- |
+  |`true` se o script de fingerprint estiver bloqueado, `false` caso contrário. | boolean |
 
 
 ### **Identificar a bandeira**
 
+Função que identifica a bandeira do cartão pelo número, com base nas [bandeiras aceitas pelo Efí](https://dev.efipay.com.br/docs/api-cobrancas/cartao#confira-a-lista-de-cart%C3%B5es-de-cr%C3%A9dito-aceitos-pela-ef%C3%AD).
+
   - **Dados de entrada:**
 
 	| Parâmetro/Método | Descrição                   | Tipo    | Obrigatório |
@@ -144,6 +175,8 @@ Neste repositório, você encontra exemplos para usar a biblioteca. Confira esse
 
 ### **Buscar as informações de parcelamento**
 
+Função para buscar as informações de parcelamento de acordo com as [configurações de recebimento em sua conta](https://app.sejaefi.com.br/configuracoes-da-conta/configuracoes-de-cobrancas/cartao-de-credito).
+
   - **Dados de entrada:**
 
 	| Parâmetro/Método | Descrição                                                                     | Tipo    | Obrigatório |
@@ -185,6 +218,8 @@ Neste repositório, você encontra exemplos para usar a biblioteca. Confira esse
 
 ### **Gerar o payment_token e card_mask**
 
+Função que gera o *payment_token*, um código criado pela API da Efí que representa os dados do cartão da pessoa pagadora, e também a *card_mask*, com base nas informações do cartão.
+
   - **Dados de entrada:**
 
 	| Parâmetro/Método  | Descrição                                                        | Tipo    | Obrigatório |
@@ -261,9 +296,6 @@ Neste repositório, você encontra exemplos para usar a biblioteca. Confira esse
   | error_description | Mensagem detalhando o erro ocorrido. | string |
 
 
-### Exemplos práticos
-Disponibilizamos alguns exemplos de utilização para as principais linguaguagens de progração front-end. [Acesse aqui](https://github.com/efipay/js-payment-token-efi/tree/main/examples).
-
 <br>
 
 ---