Interface facile à utiliser pour intégrer les applications Flutter avec l’API Pix de Sicoob

À propos du projet

Ce package offre une interface facile à utiliser pour l’intégration avec l’API Pix de Sicoob. Avec ce package, vous pouvez obtenir des informations sur les transactions rapidement et efficacement dans vos applications Flutter.

Pré-requis

• Key Pix enregistré auprès du Sicoob
• Exclusif pour les personnes morales
• Certificat valide délivré par une autorité de certification externe conforme à la norme internationale x.509
• Inscription sur le Portail des développeurs Sicoob

Commencer

Pour installer ce package dans votre projet, vous pouvez suivre les instructions ci-dessous :

a) Ajoutez dans votre pubspec.yaml :

 dependencies:
    pix_sicoob: <last-version>

b) ou utilisez :

Comment utiliser

Ce package est prêt pour obtenir rapidement des informations sur les transactions !

Commencez par instancier la classe en passant les paramètres appropriés

Obtenir un jeton

final pixSicoob = PixSicoob(
  clientID:'CLIENT_ID',
  certificateBase64String: 'X509_Parsed_TO_BASE64_STRING',
  /*
  This package offer a method to parses file certificate to base64 String
   Method:
    final certBase64String = pixSicoob.certFileToBase64String(
       pkcs12CertificateFile: File('test/cert/cert.pfx'),
       );
  */

  certificatePassword: 'CERTIFICATE_PASSWORD',
);

Pour plus d’exemples, veuillez consulter le Documentation

Caractéristiques

• PIX :
  • ✅ Récupérer les transactions PIX reçues
  • ? Récupérer une transaction de pixels spécifique
  • ? Demande de retour
  • ? Consulter le retour

)

---

Cas d’utilisation

Convertir le fichier de certificat en Base64String

final certBase64String = pixSicoob.certFileToBase64String(
   pkcs12CertificateFile: File('test/cert/cert.pfx'));

Demander un jeton

final token = await pixSicoob.getToken();

Récupérer les transactions de Pix

final listPix = await pixSicoob.fetchTransactions(
  token: token,
);
//Returns the last 4 days transactions

final listPix = await pixSicoob.fetchTransactions(
  token: token,
  dateTimeRange: DateTimeRange(
    start: DateTime.now().subtract(Duration(days: 360)),
    end: DateTime.now(),
  );
);
//Returns the transactions of the specified date range

Contribuant

? Directives de contribution – En cours de mise à jour ?

Les contributions sont ce qui fait de la communauté open source un endroit incroyable pour apprendre, inspirer et créer. Toutes les contributions que vous faites sont très appréciée.

Si vous avez une suggestion qui améliorerait cela, veuillez bifurquer le dépôt et créer une demande d’extraction. Vous pouvez également simplement ouvrir un problème avec la balise appropriée. N’oubliez pas de mettre une étoile au projet ! Merci encore!

1. Fourchez le projet
2. Créez votre branche de fonctionnalité (git checkout -b feature/AmazingFeature)
3. Validez vos modifications (git commit -m 'Add some AmazingFeature')
4. Pousser vers la branche (git push origin feature/AmazingFeature)
5. Ouvrir une demande d’extraction

N’oubliez pas d’inclure une balise et de suivre Engagements conventionnels et Versionnement sémantique lors du téléchargement de votre commit et/ou de la création du problème.

Licence

Distribué sous le MIT LICENSE.txt pour plus d’informations.

Architecture

Vérifier l’architecture utilisée dans le projet ARCHITECTURE.md

Remerciements

Merci à toutes les personnes qui ont contribué à ce projet, sans vous ce projet ne serait pas là aujourd’hui.

Entretenu par

Construit et entretenu par Systèmes AcxTech.

GitHub

Voir Github