Introduction

The Exsited v4 REST API and the seven SDKs that call it.

The Exsited v4 REST API lets you read and change your Exsited data from your own code: accounts, orders, invoices, payments, items, purchasing, work and settings. Seven SDKs, one per language, call it for you with the same set of functions, so what you learn in one SDK applies to the others. These docs cover only the endpoints that all seven SDKs implement: if a call is documented here, you can make it from any of them.

Every SDK sends a JSON request body and gives you the JSON response body back, with the API’s own field names. Nothing is renamed or reshaped in either direction.

Choose your language

Python

pip install "exsited>=4,<5"

JavaScript

npm install exsited

PHP

composer require exsited/exsited

Java

Maven: com.exsited:exsited

.NET

dotnet add package Exsited

Dart

dart pub add exsited

Go

go get github.com/exsited/exsited-sdk-go/v4

cURL

Any HTTP client, with a bearer token

What every SDK does for you

Signs in for you

Exchanges your API credentials for an access token, caches it and renews it before it expires.

One client for everything

Each area, such as accounts, has one function per endpoint, for example client.accounts.get_account("ACC0001") in Python.

JSON in, JSON out

You send the request body as a map or a JSON string, and read the decoded JSON response. You can also read the response as a typed object if you prefer.

Errors you can read

A failed call gives you the API’s error body: its code, message, the request_id to quote to support, and one entry per field that failed.

Next steps

Installation

Add the SDK for your language to a project.

Authentication

Set up a client with your API credentials.

Get an access token

Call the API directly with cURL.