0.0.1 • Published 1 year ago

ganeyipack v0.0.1

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

Description

Le paquet react-native ganeyi vous permet de tirer profit des solutions OCR et MRZ développées par Baamtu S.A.R.L à partir de votre application react-native. Ce paquet se base sur le component Ganeyi qui offre un UI customisable pour les besoins suivant:

  • Extraction d'informations des pièces d'identité
  • Extraction d'informations des factures
  • Vérification d'identité

Clé

L'utilisation du paquet necessite une clé d'api fournit après souscription à l'un des produits proposés par Ganeyi.

Installation

  1. Installer le package
npm install ganeyi-react-native
  1. Importer le paquet et utiliser le dans votre projet React Native
import Ganeyi from "ganeyi-react-native";

Packages installation and configuration


  • react-native-vector-icons
npm i react-native-vector-icons

follow the link for package configuration

package configuration guide

for android, simply add the following line in android/app/build.gradle

apply from: "../../node_modules/react-native-vector-icons/fonts.gradle"
  • react-native-image-crop-picker
npm i react-native-image-crop-picker

follow the link for package configuration package configuration guide

  • react-native-svg
npm i react-native-svg

follow the link for package configuration

package configuration guide

  • react-pdf
npm i react-pdf --force

follow the link for package configuration

package configuration guide

  • react-native-navigation
npm install @react-navigation/native @react-navigation/native-stack

follow the link for package configuration

package configuration guide

  • react-native-fetch-blob
npm install react-native-fetch-blob

follow the link for package configuration

package configuration guide

-- in node_modules find react-native-fetch-blob. go to node_modules/react-nativ-fetch-blob/android/build.gradle at line 36 and change "compile" to "implementation"

Documentation

Ce SDK vous permet à partir d'une instance Ganeyi de composer des workflow pour tirer profit des différentes solutions offertes par Baamtu S.A.R.L.

Extraction des informations

Paramètres requis

  • token: Votre clé d'api

Paramètres requis

  • component: Produit auquel vous avez souscrit

Valeurs possibles du paramétre component

  • OCR Permet de spécifier que l'on souhaite utiliser le produit OCR pour l'extraction d'information au niveau des documents suivants :
    • Facture Senelec
    • Facture Seneau
    • Facture Sonatel
    • Piéce d'identité (partie recto)Les paramètres suivants ne sont à renseigner qu'en cas de changement au niveau des produits | Paramètre | Description | Type | |------------------------|-------------------------------------------------------------------------------------------------------------|-----------------------| | product | Nom du produit | String | | version | Version du produit | String |

Exemple Dans votre fichier d'entré (App.js ou index.js) :

const App= ()=> {

  return (

     <Ganeyi
      Component= 'OCR'
      token = 'CLE_API'
     />
  )

}
  • MRZ Permet de spécifier que l'on souhaite utiliser le produit MRZ pour l'extraction d'information au niveau des documents suivants :
    • Piéces d'identité (Partie verso)
    • Passport
    • Permis de conduireLes paramètres suivants ne sont à renseigner qu'en cas de changement au niveau des produits | Paramètre | Description | Type | |------------------------|-------------------------------------------------------------------------------------------------------------|-----------------------| | product | Nom du produit | String | | version | Version du produit | String

Exemple Dans votre fichier d'entré (App.js ou index.js) :

const App= ()=> {

  return (

     <Ganeyi
      Component= 'MRZ'
      token = 'CLE_API'
     />
  )

}

Verification d'Identité

Paramètres requis

  • component: Nom du produit

Valeurs possibles du paramétre component

  • Id Verification Permet de spécifier que l'on souhaite intégrer la fonctionnalité de verification d'identité pour tout type de document

Exemple Dans votre fichier d'entré (App.js ou index.js) :

const App= ()=> {

  return (

     <Ganeyi
      Component= 'Id Verification'
     />
  )

}

Screenshots

Extraction des informations des pièces d'identité

Extraction des informations des factures

Vérification d'identité