Overview

The airSpring low-code platform makes it easy for developers to build and run applications, APIs and services to automate customer-facing forms and personalized documents. Used independently or in any combination, these services are created to work with any web service enabled application or platform to present content and enhance workflow automation.

Fill and Extract Data

This service allows you to fill or extract data from a pdf form. We’ve provided documentation and sample forms so you can quickly see how the service performs.

Start Here

To get started click on the link below to receive your token. Once you’ve registered, an email with your personal token will be sent to use for all end points in this service.

https://services.airspringsoftware.com/tokenservice

API

/fill

Pass in token you received when you registered. https://services.airspringsoftware.com/forms/api/fill.json

Parameters

"token": "3972b8cccc77ad0abfc5b5e0",
"file": "https://www.irs.gov/pub/irs-pdf/fw4.pdf",
"formData": {
  "topmostSubform[0].Page1[0].Line1[0].f1_09_0_[0]":"Ronald",
  "topmostSubform[0].Page1[0].Line1[0].f1_10_0_[0]": "Heiney"
}

Response

{
    "response": {
        "pdfComplete": true,
        "pdfRoute": "/output/pdf/fw4-4439cdd7001b895fff43c52f-5a15fd9ebfb28b2e33210e6b.pdf"
    }
}

To get the filled pdf file https://services.airspringsoftware.com/output/pdf/fw4-4439cdd7001b895fff43c52f-5a15fd9ebfb28b2e33210e6b.pdf

/extract

Pass in token you received when you registered. https://services.airspringsoftware.com/forms/api/extract.json

Parameters

token=3972b8cccc77ad0abfc5b5e0
file=https://github.com/airspringsoftware/pdf-service/blob/master/fw4-filled.pdf?raw=true

Response

{
    "response": {
        "formInfo": {
            "AcroForm": true,
            "XFA": true,
            "needsRendering": false,
            "numFields": 42
        },
        "fields": [
            {
                "index": 0,
                "type": "Text",
                "name": "topmostSubform[0].Page1[0].f1_01_0_[0]",
                "value": null,
                "options": []
            },
            {
                "index": 1,
                "type": "Text",
                "name": "topmostSubform[0].Page1[0].f1_02_0_[0]",
                "value": null,
                "options": []
            },

Samples

Fill

curl -X POST \
  https://services.airspringsoftware.com/forms/api/fill.json \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{ 
  "token": "b4ae47e50536ba055ae4134d",
  "file": "https://www.irs.gov/pub/irs-pdf/fw4.pdf",
  "formData": {"topmostSubform[0].Page1[0].Line1[0].f1_09_0_[0]": "Ronald","topmostSubform[0].Page1[0].Line1[0].f1_10_0_[0]": "Heiney"}}'

Extract

curl -X GET \
  'https://services.airspringsoftware.com:6001/forms/api/extract.json?token=3972b8cccc77ad0abfc5b5e0&file=https%3A%2F%2Fgithub.com%2Fairspringsoftware%2Fpdf-service%2Fblob%2Fmaster%2Ffw4-filled.pdf%3Fraw%3Dtrue' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json'