The Live Data API

Live Data follows an “API-first” development methodology. In short, this means that we take our APIs seriously and dogfood them ourselves – all our web applications operate on the same set of APIs that we provide our customers.

This guide will walk you through the major aspects of API development using Live Data and refers to other content in the site.

API Services

The functionality of Live Data is broken up into multiple services, each with their own versioning, endpoints, and functionality. The services currently available to users include:

Identity Service - This service is responsible for managing tenants, users, permissions, API credentials, sessions, and more.
Ledger Service - Provides all of the functionality around Ledgers, including adding contacts, viewing job changes, downloading data, and more.

Authentication

All APIs follow Oauth2 principles and are authenticated using an access token generated by creating a session. Automated API clients should use refresh tokens associated with Service Accounts, but username/password are also acceptable.

The response will include an access token and the expiration time. The response also includes other information about the user and the orgs they have access to. Once an access token is obtained, it is sent in the header of all API requests as a Bearer Token.

Example

curl -X 'POST' \
  'https://gotlivedata.io/api/identity/v1/session' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "grantType": "password",
  "email": "support@livedatatechnologies.com",
  "password": "securepassword"
}'

{
  "accessToken": "<secure token>",
  ....
  "expiresAt": "2021-11-09T05:35:16.925801"
}

Using the token

curl -X 'GET' \
  'https://gotlivedata.io/api/ledger/v1/orgs/<org id>/ledgers' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJK....'