Acrobat Sign JavaScript SDK

Last update: Apr 06, 2023.

The Acrobat Sign SDK supports integrating the Acrobat Sign RESTful web service into client applications via easy-to-consume client side objects wrapping the REST API functionality. This repository contains Acrobat Sign’s JavaScript SDK and samples for these APIs.

This SDK is automatically generated by the Swagger Codegen project:

API version: 6.0.0
Package version: 6.0.0
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

Node.js

npm

To publish the library as a npm, please follow the procedure in “Publishing npm packages”.

Then install it via:

npm install swagger-js-client --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let’s call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your swagger-js-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('swagger-js-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, for example, at 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, that’s to say your javascript file where you actually use this library):

shell
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

Follow the installation instructions and execute the following JS code:

var SwaggerJsClient = require('swagger-js-client');
var api = new SwaggerJsClient.WorkflowsApi()
var authorization = "authorization_example"; // {String} An OAuth Access Token with scopes: 'workflow_read' in the format 'Bearer {accessToken}'.

var opts = {
  'xApiUser': "xApiUser_example", // {String} The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token.
  'includeDraftWorkflows': true, // {Boolean} Include draft workflows
  'includeInactiveWorkflows': true, // {Boolean} Include inactive workflows
  'groupId': "groupId_example" // {String} The group identifier for which the workflows will be fetched
};
api.getWorkflows(authorization, opts)
  .then(function(data) {
    console.log('API called successfully. Returned data: ' + data);
  }, function(error) {
    console.error(error);
  }
);

Recommendation

It’s recommended to create an instance of ApiClient per thread and per user (with baseUris fetched for user) in a multithreaded environment to avoid any potential issues.

JS SDK docs and downloads

Reporting issues

Please report issues on the Acrobat Sign Developer Forum.