Back to menu

<aside> ⚠️ NOTE: This guide is a work in progress and a placeholder for a guide we know we’ll need. Certain details, such as API authorization, API domains, and API endpoints, are not yet finalized.

</aside>

At A Glance

This guide offers a concise yet comprehensive overview of integrating the LiveBy API into your projects. We'll walk you through the essentials - from initial setup and authentication to executing basic operations. Our goal is to equip you with the knowledge and tools needed to quickly leverage the LiveBy API, enhancing your applications with its powerful features. Get ready to unlock new possibilities in a few simple steps!

Create an Account

If you do not already have a LiveBy account, you will need to create one to use our API.

First, create a LiveBy Account or Sign In. Next, navigate to the API key page and click "Generate API Key”.

Generate Your API Key

The simplest way to access the LiveBy API directly is to generate an API key.

1. Navigate to the API Keys section of your LiveBy account.
2. Select "Create New Key" optionally naming the key. Immediately copy the newly generated key and store it in a secure location.

<aside> 🔐 Make sure to save this somewhere safe, and do not share it with anyone. Once the key generation process is complete, you can no longer view or copy it.

</aside>

Make Your First API Call

To test that you have everything set up correctly, we have created a test endpoint that will let you ping the LiveBy API servers.

token="YOUR_API_TOKEN"

curl -sS \\
  "<https://api.liveby.com/4.0/ping>" \\
  -H "Authorization: Bearer ${token}" | jq -r

If everything was set up correctly, a successful response should look like the following:

{
  "success": true,
  "data": {
		"health_report": "Everything is great!"
	}
}

Next:

Data Sources & Version Numbers