Rootshive Disbursement
The Rootshive API provides extensive access to the features available on our dashboard, enabling you to leverage them for your own 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).
- Use a valid API Key to send requests to the API endpoints. You can get your API key from your www.therootshive.com's dashboard.
- The API has rate and usage limits.
- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
- The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
BaseUrl
https://api.therootshive.com/V1
Authentication error response
If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
| Header | Description |
|---|---|
X-RateLimit-Limit |
The maximum number of requests that the consumer is permitted to make per minute. |
X-RateLimit-Remaining |
The number of requests remaining in the current rate limit window. |
X-RateLimit-Reset |
The time at which the current rate limit window resets in UTC epoch seconds. |
503 response
An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.
Need some help?
In case you have questions, go through our tutorials ((link to your video or help documentation here)). Or visit our FAQ page ((link to the relevant page)).
Or you can check out our community forum, there’s a good chance our community has an answer for you. Visit our developer forum ((link to developer forum)) to review topics, ask questions, and learn from others.