@weesign/weesign

v0.2.7

Published

4 years ago

weesign sdk for signing the document

0High
0Medium
0Low

josejaguirre

Features

Create Access Token
Add New Document
Update an existing Document
Update an fixed position signatory in Document
Delete Document
Get All document assiciated with a user
Get a particular Document
Add Signatory of a document
Share a completed document through a mail
Validate Document
Add WebHook
Update WebHook
Get WebHook
Delete WebHook

Installation

# With npm
npm install --save @weesign/weesign

Usage Examples

Create Access Token

This example Create Access Token.

const weesign = require('@weesign/weesign');

// data to be passed for create access token
const data = {
   'user-id': '[USER-ID]',
   'api-key': '[API-KEY]',
}

// where 'user-id' is userID of user and 'api-key' is a key used for using weesign
//'user-id' and 'api-key' can get using the following steps:
//   Sign up and login on https:www.weesign.mx and choose a subscription plan
//   Note userID and ApiKey from the profile section (if apiKey not available then you can Generate by   clicking on Generate API key button)

// Create access token
// (Note: this access token is valid up to 5 minutes)

const response = await weesign.accessToken(data);

// and the reponse will be look like this
// { responseData: { accessToken: 'f1a664ea710062baae92bc59d5bd8560d2c4929b' },
//  message: 'Token generated Successfully',
//  success: true,
//  responseCode: 200 }

Add New Document

This example Add New Document.

const weesign = require('@weesign/weesign');

// data to be passed for Add New Document
const firstPath = path.normalize(`${__dirname}/dummy.pdf`);
const file = await fs.createReadStream(firstPath);

const data = {
   'user-id': '[USER-ID]',
   token: '[TOKEN-ID]',
   file,
   documentSignType: 'ELECTRONIC_SIGNATURE',
   country: 'Mexico',
   language: 'es',
   position: ""
};

// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'file' can be file Object or ReadStream Object
// 'documentSignType' Type of signature can be ELECTRONIC_SIGNATURE or E_FIRMA
// 'country' country  is country name For example Mexico, United States, Canada, New Zealand, Australia, Afghanistan, Aland Islands, Albania
// 'language' language for sending mail format in spanish or english. For spanish language is 'es' and For english language is 'en'
// 'position' Available values : geolocation

const response = await weesign.addDocument(data);


// and the reponse will be look like this
// { "responseData": {
//     "documentID": "5d4adeac1d6391bc05d13be",
//      "documentType": "OTHER",
//      "status": "DRAFT",
//      "country": "Mexico",
//      "documentSignType": "ELECTRONIC_SIGNATURE",
 //     "addedOn": 1565188066047,
 //     "documentFileObj": {
 //       "url": "https://signing-file.s3.amazonaws.com/sample.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIXB7WAVV4G_7T142236Z&X-Amz-Expires=518400&X-Amz-Signature=eb6938817d3e0be20c7ca23b16991fb90b6e65f9aabf22ca3d4d4f01a4548241&X-Amz-SignedHeaders=host",
  //      "size": "2.6 MB"
  //    },
  //    "signatory": []
  //  },
//  "message": "Document added successfully",
// "success": true,
//  "responseCode": 200
//}

Update an existing Document

This example for Update an existing Document.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit and status have DRAFT

// data to be passed for update Document
const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'documentID': 'd5e6287a556a72ef9db209e1b',
   'documentSignType': 'ELECTRONIC_SIGNATURE',
   'country': 'United States',
   'position': '',
};

// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'documentID' is Id of od document which to be update
// "documentSignType" is type of signature for sign the document. documentSignType either "ELECTRONIC_SIGNATURE" or "E_FIRMA"
// "country" is country name for example United States, Mexico etc
const reponse = await weesign.updateDocument(data);

// and the reponse will be look like this
// { "responseData": {
//     "documentID": "5d4adeac1d6391bc05d13be",
//      "documentType": "OTHER",
//      "status": "DRAFT",
//      "country": "United States",
//      "documentSignType": "ELECTRONIC_SIGNATURE",
 //     "addedOn": 1565188066047,
 //     "documentFileObj": {
 //       "url": "https://signing-file.s3.amazonaws.com/sample.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIXB7WAVV4G_7T142236Z&X-Amz-Expires=518400&X-Amz-Signature=eb6938817d3e0be20c7ca23b16991fb90b6e65f9aabf22ca3d4d4f01a4548241&X-Amz-SignedHeaders=host",
  //      "size": "2.6 MB"
  //    },
  //    "signatory": []
  //  },
//  "message": "Document updated Successfully",
// "success": true,
//  "responseCode": 200
//}

Update an fixed position signatory in Document

This example for Update signatory position in existing Document.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit and status have DRAFT

// data to be passed for update fixed signatory in Document
const data = {
   'user-id': '[USER-ID]',
   token: '[TOKEN-ID]',
   documentID: 'd5e6287a556a72ef9db209e1e',
   staticSignPositions: [{
      user:{
         email: '[email protected]',
      },
      coordinates: {
         x: 23.12,
         y: 13.08,
      },
      page: 0,
      pageY: 0,
      color: '#FFD247',
      imageSize: {
         width: '16.13',
         height: '6.08',
      },
      parentImageSize: {
        width: 930,
        height: 1315,
      },
      viewport: {
        width: "string",
        height: "string"
      },
   }],
};

// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'documentID' is Id of od document which to be update
// "documentSignType" is type of signature for sign the document. documentSignType either "ELECTRONIC_SIGNATURE" or "E_FIRMA"
// "country" is country name for example United States, Mexico etc
const reponse = await weesign.updateFixedPositionDocument(data);

// and the reponse will be look like this
// { "responseData": {
//     "documentID": "5d4adeac1d6391bc05d13be",
//      "documentType": "OTHER",
//      "status": "DRAFT",
//      "country": "United States",
//      "documentSignType": "ELECTRONIC_SIGNATURE",
 //     "addedOn": 1565188066047,
 //     "documentFileObj": {
 //       "url": "https://signing-file.s3.amazonaws.com/sample.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIXB7WAVV4G_7T142236Z&X-Amz-Expires=518400&X-Amz-Signature=eb6938817d3e0be20c7ca23b16991fb90b6e65f9aabf22ca3d4d4f01a4548241&X-Amz-SignedHeaders=host",
  //      "size": "2.6 MB"
  //    },
  //    "signatory": []
  //  },
//  "message": "Document updated Successfully",
// "success": true,
//  "responseCode": 200
//}

Delete Document

This example for Delete Document.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit and document status either DRAFT Pending(none of the signatories has signed)

// data to be passed for update Document
const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'documentID': 'd5e6287a556a72ef9db209e1b'
};

// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'documentID' is Id of od document which to be update

const reponse = await weesign.deleteDocument(data);

// and the reponse will be look like this
// { responseData: {},
//  message: 'Document Deleted successfully',
//  success: true,
//  responseCode: 200 }

Get All document assiciated with a user

This example for Get All document assiciated with a user.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit and document status either DRAFT Pending(none of the signatories has signed)

// data to be passed for get all Document
const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'status': 'ALL',
   'limit':1,
   'skip': 0,
};
// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'status' status of document which can either DRAFT, PENDING, and COMPLETED. Default value : ALL for getting all document.
// 'limit' limit the number of document for getting
// 'skip' skip the number of previous document list 

const response = await weesign.getDocuments(data);


// and the reponse will be look like this
// { "responseData": [
//    {
//     "documentID": "5d4adeac1d6391bc05d13be",
//      "documentType": "OTHER",
//      "status": "DRAFT",
//      "country": "United States",
//      "documentSignType": "ELECTRONIC_SIGNATURE",
 //     "addedOn": 1565188066047,
 //     "documentFileObj": {
 //       "url": "https://signing-file.s3.amazonaws.com/sample.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIXB7WAVV4G_7T142236Z&X-Amz-Expires=518400&X-Amz-Signature=eb6938817d3e0be20c7ca23b16991fb90b6e65f9aabf22ca3d4d4f01a4548241&X-Amz-SignedHeaders=host",
  //      "size": "2.6 MB"
  //    },
  //    "signatory": []
  //  }
//  ],
//  "message": "Document Gets Successfully",
// "success": true,
//  "responseCode": 200
//}

Get a particular Document

This example for Get a particular Document.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit 

// data to be passed for get a particular Document
const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'documentID': 'a556a72ef9db209e1b878b8a6b'
}
// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'documentID' id of document which you want to get.

const response = await weesign.getDocumentByID(data);


// and the reponse will be look like this
// { "responseData": {
//     "documentID": "a556a72ef9db209e1b878b8a6b",
//      "documentType": "OTHER",
//      "status": "DRAFT",
//      "country": "United States",
//      "documentSignType": "ELECTRONIC_SIGNATURE",
//     "addedOn": 1565188066047,
//     "documentFileObj": {
//       "url": "https://signing-file.s3.amazonaws.com/sample.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIXB7WAVV4G_7T142236Z&X-Amz-Expires=518400&X-Amz-Signature=eb6938817d3e0be20c7ca23b16991fb90b6e65f9aabf22ca3d4d4f01a4548241&X-Amz-SignedHeaders=host",
//      "size": "2.6 MB"
//    },
//    "signatory": []
//  },
//  "message": "Document Get Successfully",
// "success": true,
//  "responseCode": 200
//}

Add Signatory of a document

This example for Add Signatory of a document.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit 

// data to be passed for Add signatory of a Document
const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'documentID': 'a556a72ef9db209e1b878b8a6b',
   'message': 'hello',
   'title': 'sign the document',
   'disableMailing': true,
   'signatory': [{
      'emailID': '[email protected]',
      'name': 'name of user'
      'identification': 'id, face',
      'check': true
   }],
};

// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'documentID' id of document which you want to get.
// 'message' message is text that will we  send in the mail to the signatories.
// 'title' title is text that will we send in the mail to the signatories.
// 'disableMailing' this value determines if an email is sent through the platform
// 'signatory' signatory is a array of object and each object contain email address and name of signatory.
// (Note: The signatory of document can add if document status is DRAFT.)

const response = await weesign.addSignatory(data);


// and the reponse will be look like this
// { "responseData": {
//     "documentID": "a556a72ef9db209e1b878b8a6b",
//      "documentType": "OTHER",
//      "status": "DRAFT",
//      "country": "United States",
//      "documentSignType": "ELECTRONIC_SIGNATURE",
 //     "addedOn": 1565188066047,
 //     "documentFileObj": {
 //       "url": "https://signing-file.s3.amazonaws.com/sample.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIXB7WAVV4G_7T142236Z&X-Amz-Expires=518400&X-Amz-Signature=eb6938817d3e0be20c7ca23b16991fb90b6e65f9aabf22ca3d4d4f01a4548241&X-Amz-SignedHeaders=host",
  //      "size": "2.6 MB"
  //    },
  //    "signatory": [
 // {
  //        "isSigned": 0,
 //       "signatoryID": "346fg7j65787uhgui76"
 //       "emailID": "[email protected]",
 //       "name":"name of user"
 //     }]
  //  },
//  "message": "Signatory added successfully",
// "success": true,
//  "responseCode": 200
//}

Share a completed document through a mail

This example for Share a completed document through a mail.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit 

// data to be passed for Share a completed document through a mail
const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'documentID': 'a556a72ef9db209e1b878b8a6b',
   'postedTo': '[email protected]'
}
// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'documentID' id of document which you want to get.
// 'postedTo' postedTo is email address who will receive this document.
// (Note: the document ony can share to someone  if document status is COMPLETED.)

const response = await weesign.shareDocument(data);


// and the reponse will be look like this
// { "responseData": {},
//  "message": "Document sent successfully",
// "success": true,
//  "responseCode": 200
//}

Validate Document

This example for Validate a completed Document.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit 

// data to be passed for Validate Document

const firstPath = path.normalize(`${__dirname}/dummy.pdf`);
const file = await fs.createReadStream(firstPath);

const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   file,
};

// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'file' can be file Object or ReadStream Object

const response = await weesign.validateDocument(data);


// and the reponse will be look like this
// { "responseData": {},
//  "message": "Document Validated successfully",
// "success": true,
//  "responseCode": 200
//}

Add WebHook

This example for Add WebHook.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit 

// data to be passed for Add WebHook

const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'url': 'https://example.com',
   'type': 'completedDocument'
};
// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'url' url of the hook which will be htted on particular action For Example signDocument, completedDocument.
//  'type' type define the type webHook and type can be either completedDocument, or signDocument

const response = await weesign.addWebHook(data);


// and the reponse will be look like this
// { "responseData": {
//      "type": "completedDocument",
//      "webHookID": "h4nitekddgtgStllates",
//      "webHookUrl": "https://example.com",
 //     "addedOn": 1565188066047,
 // },
//  "message": "WebHook added successfully",
// "success": true,
//  "responseCode": 200
//}

Update WebHook

This example for Update WebHook.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit 

// data to be passed for Update WebHook

const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'url': 'https://example.com',
   'webHookID': '6287a556a72ef9db209e1b878b'
};
// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
// 'url' 'url' url is webHook url to be update
//  'webHookID' webHookID a particular webHook to be update.

const response = await weesign.updateWebHook(data);


// and the reponse will be look like this
// { "responseData": {
//      "type": "completedDocument",
//      "webHookID": "6287a556a72ef9db209e1b878b",
//      "webHookUrl": "https://example.com",
 //     "addedOn": 1565188066047,
 // },
//  "message": "WebHook updated successfully",
// "success": true,
//  "responseCode": 200
//}

Get WebHook

This example for Get WebHook.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit 

// data to be passed for Get WebHook

const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'webHookID': '6287a556a72ef9db209e1b878b'
};
// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
//  webHookID' webHookID is Optional for getting a particular webHook.

const response = await weesign.getWebHook(data);

// and the reponse will be look like this
// { "responseData": [{
//      "type": "completedDocument",
//      "webHookID": "6287a556a72ef9db209e1b878b",
//      "webHookUrl": "https://example.com",
 //     "addedOn": 1565188066047,
 // }],
//  "message": "WebHook get successfully",
// "success": true,
//  "responseCode": 200
//}

Delete WebHook

This example for Delete WebHook.

const weesign = require('@weesign/weesign');

// Prerequisite: User needs to have a userID, access token and document should exit 

// data to be passed for Delete WebHook

const data = {
   'user-id': '[USER-ID]',
   'token': '[TOKEN-ID]',
   'webHookID': '6287a556a72ef9db209e1b878b'
};
// 'user-id' is userID of document Owner/Creater
// 'token' is acces token which is generated using accessToken()
//  'webHookID' webHookID a particular webHook to be delete.

const response = await weesign.deleteWebHook(data);


// and the reponse will be look like this
// { "responseData": {},
//  "message": "WebHook deleted successfully",
// "success": true,
//  "responseCode": 200
//}