Quick Start

Good to know: Before you start integrating into Rootshive, it's necessary to create an account. To learn about the various account types that Rootshive offers, Click here. To create a Rootshive Account, Click here

Introduction

The Rootshive API provides extensive access to the features available on our dashboard, enabling you to leverage them for your application. To get started, you must first create a Rootshive account on www.therootshive.com and obtain the required API keys for all Rootshive integrations. Please note that the Rootshive API is secured through Basic Authentication or OAuth (Bearer Tokens).

You can access your API key from your Dashboard any time.

Going Live

After successfully uploading the necessary documents and meeting compliance requirements, your Rootshive account will be activated, and you will be ready to go live. Before commencing integration, it is imperative to verify the proper configuration of specific components to facilitate seamless integration and communication between Rootshive, your business, and your customers.

When transitioning your project from development to production with Rootshive, it's essential to update all sandbox credentials to their live counterparts. Make sure to replace the Sandbox base_url, API Key, and Secret with the live versions.

Good to know: Rootshive Environments

Sandbox Mode {{baseUrl}} : https://sandbox.therootshive.com Live Mode {{baseUrl}} : https://api.therootshive.com

IP Whitelisting

For security, it's critical to provide your server's IP to Rootshive for whitelisting, ensuring that only requests from this specific IP are accepted. Alternatively, you can configure your dashboard settings to allow requests from any IP address.

Making your first request

To begin, submit an authenticated request to the check source endpoint.

Check Source

POST https://{{baseUrl}}.therootshive.com/V1/

Authorization basic

Authorize this API call by including an Authorization header that contains the word 'Basic' followed by a space and a base64-encoded string 'apiKey:clientSecret' i.e. 'Basic base64(appid:rhlive)', include the Token in the request header.

200 Source Retrieved

{
    "status": "200",
    "log": "True",
    "data": {
        "message": "Source Retrieved",
        "source": "102.89.47.117"
    }
}

401 Permission denied

{
    "status": "401",
    "logged": false,
    "data": {
        "message": "Authorization required"
    }
}