API client libraries

Draftable maintains several open-source client libraries, making it easy to use the API from C#/.NET, Java, Python, and Node.js. Each library is a thin wrapper around the API that handles making the requests, as well as authentication and signing. The libraries are fully documented in their READMEs on GitHub.

The client libraries work with both cloud and self-hosted Draftable. They are not version specific, so this article applies whichever you are using.

If you are deploying API Self-Hosted, Version 2 is legacy.

All new self-hosted deployments must use Version 3, which features a modern multi-container architecture with improved security and performance.

👉 Get started with API Self-Hosted v3

Pointing a client library at a self-hosted instance

By default the libraries connect to the cloud API. To use your own instance, pass your base API URL as the third parameter when constructing the client.

The URL must end in /v1, with no trailing slash. For an instance at draftable.mycompany.com:

https://draftable.mycompany.com/api/v1

client = draftable.Client(ACCOUNT_ID, AUTH_TOKEN, "https://draftable.mycompany.com/api/v1")

A trailing slash, or a URL missing the /v1 suffix, is the most common cause of a client library failing to connect to a self-hosted instance.

To find the most up to date information on our client libraries, please refer to our documentation on our website which can be found here.

However for quick reference, below is links to our GitHub repositories for each client library.

C# and .NET

Github link

Java

Github link

Python

Github link

Node.js

Github link