https://github.com/motdotla/signatureio-node

Node.js Bindings for Signature.io's API.
https://github.com/motdotla/signatureio-node

Last synced: 7 months ago
JSON representation

Node.js Bindings for Signature.io's API.

• Host: GitHub
• URL: https://github.com/motdotla/signatureio-node
• Owner: motdotla
• Created: 2013-02-06T03:23:26.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2013-07-28T00:41:08.000Z (about 12 years ago)
• Last Synced: 2024-05-21T10:55:05.765Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 172 KB
• Stars: 4
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Signatureio-Node

Node.js Bindings for Signature.io's API.

[![Build Status](https://travis-ci.org/scottmotte/signatureio-node.png)](https://travis-ci.org/scottmotte/signatureio-node)

## Installation

    $ npm install signatureio

## Usage overview

    var secret_api_key  = 'abc';  // Your Secret Signature.io API Key

    var signatureio     = require('signatureio')(secret_api_key);

    signatureio.documents.all(

      { },

      function(response) {

        if (response.success) {

          console.log(success.error.message);

          return;

        } else {

          console.log(success.documents);

          return;

        };

      }

    );

Alternatively, you can simply set the environment variable SIGNATURE_SECRET_API_KEY on your machine. The node module will read it automatically so that you can simply call:

    var signatureio = require('signatureio');

## API

All methods takes a callback as their last parameter. The callback is called with the response.

* `signatureio.documents` - create, retrieve, all

  * `all(filters)` - list documents

  * `create(document)` - create a document

  * `retrieve(document_id)` - retrieve a document by document id