FormAPI - JavaScript client for formapi FormAPI is a service that helps you fill out and sign PDF templates. This SDK is automatically generated by the OpenAPI Generator project:
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install formapi --save
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 formapi from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('formapi') in javascript files from the directory you ran the last
command above from.
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
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):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
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
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var FormAPI = require('formapi');
var defaultClient = FormAPI.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
var api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME'
api_token_basic.password = 'YOUR PASSWORD'
var api = new FormAPI.PDFApi()
var templateId = tpl_000000000000000001; // {String}
var requestBody = [null]; // {[Object]}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.batchGeneratePdfV1(templateId, requestBody, callback);
All URIs are relative to https://api.formapi.io/api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| FormAPI.PDFApi | batchGeneratePdfV1 | POST /templates/{template_id}/submissions/batch | Generates multiple PDFs |
| FormAPI.PDFApi | batchGeneratePdfs | POST /submissions/batches | Generates multiple PDFs |
| FormAPI.PDFApi | combinePdfs | POST /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files |
| FormAPI.PDFApi | combineSubmissions | POST /combined_submissions | Merge generated PDFs together |
| FormAPI.PDFApi | createCustomFileFromUpload | POST /custom_files | Create a new custom file from a cached presign upload |
| FormAPI.PDFApi | createDataRequestToken | POST /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication |
| FormAPI.PDFApi | createFolder | POST /folders/ | Create a folder |
| FormAPI.PDFApi | createTemplate | POST /templates | Upload a new PDF template with a file upload |
| FormAPI.PDFApi | createTemplateFromUpload | POST /templates?v=2 | Create a new PDF template from a cached presign upload |
| FormAPI.PDFApi | deleteFolder | DELETE /folders/{folder_id} | Delete a folder |
| FormAPI.PDFApi | expireCombinedSubmission | DELETE /combined_submissions/{combined_submission_id} | Expire a combined submission |
| FormAPI.PDFApi | expireSubmission | DELETE /submissions/{submission_id} | Expire a PDF submission |
| FormAPI.PDFApi | generatePDF | POST /templates/{template_id}/submissions | Generates a new PDF |
| FormAPI.PDFApi | getCombinedSubmission | GET /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs) |
| FormAPI.PDFApi | getDataRequest | GET /data_requests/{data_request_id} | Look up a submission data request |
| FormAPI.PDFApi | getPresignUrl | GET /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket |
| FormAPI.PDFApi | getSubmission | GET /submissions/{submission_id} | Check the status of a PDF |
| FormAPI.PDFApi | getSubmissionBatch | GET /submissions/batches/{submission_batch_id} | Check the status of a submission batch job |
| FormAPI.PDFApi | getTemplate | GET /templates/{template_id} | Get a single template |
| FormAPI.PDFApi | getTemplateSchema | GET /templates/{template_id}/schema | Fetch the JSON schema for a template |
| FormAPI.PDFApi | listFolders | GET /folders/ | Get a list of all folders |
| FormAPI.PDFApi | listTemplates | GET /templates | Get a list of all templates |
| FormAPI.PDFApi | moveFolderToFolder | POST /folders/{folder_id}/move | Move a folder |
| FormAPI.PDFApi | moveTemplateToFolder | POST /templates/{template_id}/move | Move Template to folder |
| FormAPI.PDFApi | renameFolder | POST /folders/{folder_id}/rename | Rename a folder |
| FormAPI.PDFApi | testAuthentication | GET /authentication | Test Authentication |
| FormAPI.PDFApi | updateDataRequest | PUT /data_requests/{data_request_id} | Update a submission data request |
FAQs
An API client for the FormAPI PDF generation service
The npm package formapi receives a total of 281 weekly downloads. As such, formapi popularity was classified as not popular.
We found that formapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.
Research
Security News
Socket researchers uncovered a backdoored typosquat of BoltDB in the Go ecosystem, exploiting Go Module Proxy caching to persist undetected for years.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.