https://github.com/panosoft/pdf-form-fill-server

https://github.com/panosoft/pdf-form-fill-server

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/panosoft/pdf-form-fill-server
• Owner: panosoft
• Created: 2016-02-01T20:08:30.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-04T23:20:33.000Z (almost 9 years ago)
• Last Synced: 2023-04-10T13:46:21.507Z (over 1 year ago)
• Language: JavaScript
• Size: 458 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Pdf Form Fill Server

> A server that renders filled pdf forms.

[![npm version](https://img.shields.io/npm/v/@panosoft/pdf-form-fill-server.svg)](https://www.npmjs.com/package/@panosoft/pdf-form-fill-server)

[![Travis](https://img.shields.io/travis/panosoft/pdf-form-fill-server.svg)](https://travis-ci.org/panosoft/pdf-form-fill-server)

# Installation

```sh

npm install -g @panosoft/pdf-form-fill-server

```

# Usage

```sh

Usage: pdf-form-fill-server --key  --cert  [options]

Render filled pdf forms.

Options:

  -h, --help                    output usage information

  -V, --version                 output the version number

  -k, --key               Path to the private key of the server in PEM format.

  -c, --cert              Path to the certificate key of the server in PEM format.

  -p, --port              The port to accept connections on. Default: 8443.

  -i, --interface    The interface to accept connections on. Default: 0.0.0.0.

```

# HTTPS API

## Request

- Path: `/`

- Method: `POST`

- Headers:

	- `Content-Type` - `'application/json'`

- Body

	- `input` - {Object}

		- `formFile` - {Base64} The pdf form containing fields to be filled.

		- `formData` - {Object} The data used to fill the supplied form in the following format: `{ :  }`.

## Responses

__Success__

- Status Code: `200`

- Headers:

	- `Request-Id` - {String} The unique request identifier.

	- `Content-Type` - `'application/pdf'`

- Body: {Buffer} The pdf binary.

__Error__

- Status Code: `500`

- Headers:

	- `Request-Id` - {String} The unique request identifier.

	- `Content-Type` - `'application/json'`

- Body:

	- `error` - {String} The error message.