Skip to content

sanderPostma/ez-docseal-js-sdk

Repository files navigation

ez_doc_seal

EzDocSeal - JavaScript client for ez_doc_seal The easiest API to sign PDF documents, creating a blue bar. You provide a name, e-mail address, location and reason and the result is a signed PDF document. If you want more features and/or control we suggest to use our PDF stamper API. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.1.0
  • Package version: 0.1.0
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

cd ez

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages". \

npm install ez_doc_seal --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var EzDocSeal = require('ez_doc_seal');
var defaultClient = EzDocSeal.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new EzDocSeal.DefaultApi()
var body = new EzDocSeal.JsonSignRequest(); // {JsonSignRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sign(body, callback);

Documentation for API Endpoints

All URIs are relative to https://api.dev.sphereon.io/ezdocseal/v1

Class Method HTTP request Description
EzDocSeal.DefaultApi sign POST /sign

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published