Aller au contenu principal

node-js

Exemple de nœud Ignisign : Intégration du SDK Ignisign NodeJS​

Ce dépôt offre un exemple pratique d'intégration du SDK Ignisign NodeJS dans votre application. L'exemple est un backend CRM simple, démontrant les fonctionnalités clés d'Ignisign.

Prérequis​

  • NodeJS, version 18.0.0 ou supérieure
  • NPM ou Yarn

Configuration et utilisation​

  1. Configuration de l'environnement : Commencez par créer un fichier .env à partir de .env.example. Remplissez vos identifiants Ignisign.

  2. Obtenir les clés API :

    • Trouvez votre appId, appEnv et appSecret dans la section "API Keys" de la Console Ignisign.
    • Spécifiez un signatureProfileId, disponible dans la section "Signature Profile" de la Console Ignisign. Sélectionnez votre profil de signature souhaité, développez ses détails et copiez la valeur SignatureProfileId.

  3. Configuration d'un point de terminaison Webhook :

    • Créez un point de terminaison webhook dans votre application et enregistrez-le dans la Console Ignisign.
    • Envisagez d'utiliser ngrok pendant votre développement pour établir un tunnel vers votre localhost. (Remarque : Ceci est une suggestion, pas une approbation.)
    • Votre point de terminaison webhook doit suivre le format : {your_url}/v1/ignisign-webhook.

  4. Installation et lancement :

    • Installez les dépendances avec yarn install (ou npm install).
    • Lancez l'application en utilisant yarn dev.

Intégration avec l'exemple Ignisign JS​

  • Associez ce backend avec l'exemple Ignisign JS (../ignisign-js).
  • Suivez les instructions dans le README.md de l'exemple Ignisign JS pour la configuration et l'installation.

Points clés sur les interactions Ignisign​

  • Interactions principales : Le fichier src/services/ignisign-sdk-manager.service.ts gère les interactions essentielles avec l'API Ignisign.
  • Principaux points de terminaison :
    • src/controllers/app.controller.ts :
      • POST /v1/ignisign-webhook pour recevoir les webhooks Ignisign.
      • GET /v1/files/:fileHash/private-file-info pour fournir des informations sur les fichiers privés au SDK IgnisignJS.
      • GET /v1/app-context offre un champ requiredInputs pour déterminer les informations nécessaires à la création d'un signataire.
    • src/controllers/contract.controller.ts :
      • POST /v1/contracts pour créer des demandes de signature.
    • src/controllers/customer.controller.ts et src/controllers/seller.controller.ts :
      • POST /v1/customers et POST /v1/seller pour créer des signataires.

Informations supplémentaires​