OpenAPI Specification (Swagger)

We define our API endpoints and request/response schemas with an OpenAPI Specification (formerly known as Swagger.)

• View OpenAPI specification and try out API endpoints in Swagger UI
  • You will need an API token to test any API requests.
• OpenAPI specification (openapi.json)

Generated API Client Libraries

We use openapi-generator to automatically generate our API clients. We've also added some custom code to our clients, including some helper functions that wait for PDFs to be processed.

Please let us know if we don't support your programming language, and we'll work on an official API client. However, if you need to build an integration quickly, the fastest way would be to just send us HTTP requests using your favorite HTTP library.

You could also try generating 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 "https://docspring.com/api-docs/v1/openapi.json" \
  --generator-name elixir \
  --output "./docspring-elixir"

Here's the 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..)