Introduction

The Smokeball API conforms to REST. Our API has predictable resource-oriented URLS, accepts JSON request bodies, returns JSON and uses standard HTTP status codes and verbs.

If you’ve developed a software solution for the Legal Industry, an opportunity may exist to work with Smokeball to help our clients ‘Run Their Best Firm’.

To start your integration journey with Smokeball, please follow this link to complete the registration of interest form, and a member from our Partnerships or Product Teams will be in touch.

1. Base URLs

Refer to the below base urls for different environments and regions.

You MUST use the URLs for the region you are targeting with your integration.*

1.1 Authentication

Use this base URL for authentication.

Region	Production	Staging/Test
US	https://auth.smokeball.com	https://datastaging-auth.smokeball.com
AU	https://auth.smokeball.com.au	https://datastaging-auth.smokeball.com.au
UK	https://auth.smokeball.co.uk	https://datastaging-auth.smokeball.co.uk

1.2 API

Use this base URL for making api requests.

Region	Production	Staging/Test
US	https://api.smokeball.com	https://stagingapi.smokeball.com
AU	https://api.smokeball.com.au	https://stagingapi.smokeball.com.au
UK	https://api.smokeball.co.uk	https://stagingapi.smokeball.co.uk

2. Throttling & Limits

Throttling and limiting is a policy that affects the frequency an API can be called. They are put in place to protect server infrastructure from abuse or misuse. Smokeball employs rate limits to enable consistent load allocation across our platform.

The Smokeball API uses the token bucket algorithm. Smokeball API partners are assigned a “Burst” and “Rate” Limit.

The burst limit defines the number of requests the API can handle concurrently.

The rate limit defines the number of allowed requests per second.

Unless otherwise specified, Smokeball API partners are assigned the limits below:

Region	Rate (requests per second)	Burst (concurrent requests)
US	5	5
AU	5	5
UK	5	5