Install an API Client

Add formapi to your package.json

npm install formapi --save

Or with Yarn:

yarn add formapi

Run the following command to install the form_api gem:

gem install form_api --no-rdoc --no-ri

Or add the following to your Gemfile:

gem "form_api"

Then run:

bundle install

Run the following command to install the form_api package:

pip install --upgrade form_api


easy_install --upgrade form_api

Run the following command to install the formapi/formapi package:

composer require formapi/formapi

Or add the following to your composer.json:

    "require": {
        "formapi/formapi": "*"

Then run:

composer install


Add the following to the <dependencies> section in your pom.xml:



Add the following to the dependencies section in your build.gradle:

compile 'io.formapi:FormAPI:1.0.0'

Install the FormApi.Client package from NuGet:

Package Manager

 Install-Package FormApi.Client -Version 1.0.0


dotnet add package FormApi.Client --version 1.0.0

Paket CLI

paket add FormApi.Client --version 1.0.0

If you would like FormAPI to support a new language, please send us an email at: [email protected]

We define our API endpoints and request/response schemas with an OpenAPI Specification (formerly known as Swagger.) We use openapi-generator to automatically generate our API clients.

You can find our OpenAPI v2 specification here:

After we generate an API client, we like to add some helper methods that wait for PDFs to be processed. We also write a set of integration tests that we run against our backend code.

If you need to build an integration quickly, the fastest way would be to just send us HTTP requests using your favorite library.

Another option is to generate your own API client with openapi-generator. Follow the installation instructions to install openapi-generator. Then generate an API client using our OpenAPI specification:

openapi-generator-cli generate \
  --input-spec "" \
  --generator-name elixir \
  --output "./formapi-elixir"

Here's a list of languages that openapi-generator supports:

ActionScript, Ada, Apex, Bash, C# (.net 2.0, 3.5 or later), C++ (cpprest, Qt5, Tizen), Clojure, Dart (1.x, 2.x), Elixir, Elm, Eiffel, Erlang, Go, Groovy, Haskell (http-client, Servant), Java (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured, Spring 5 Web Client), Kotlin, Lua, Node.js (ES5, ES6, AngularJS with Google Closure Compiler annotations, Flow types) Objective-C, Perl, PHP, PowerShell, Python, R, Ruby, Rust (rust, rust-server), Scala (akka, http4s, scalaz, swagger-async-httpclient), Swift (2.x, 3.x, 4.x), Typescript (AngularJS, Angular (2.x - 6.x), Aurelia, Fetch, Inversify, jQuery, Node)

(This list might be out of date. You can find an up-to-date list in the README..)

results matching ""

    No results matching ""