Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

TandemDrive API

Welcome to the TandemDrive API guide. This document provides a high-level overview and complements the detailed API specification.

The TandemDrive API enables seamless integration of your systems with the TandemDrive platform. By utilizing our API, you can extend and automate various aspects of TandemDrive’s capabilities. To get started, API credentials can be obtained from “TandemDrive Console”.

It is essential to thoroughly review this guide to prevent any potential mistakes when working with our API. Understanding the best practices and guidelines will help you fully leverage the API’s capabilities and avoid certain pitfalls.

If you have any questions or need assistance, please don’t hesitate to reach out to our support team. We are here to ensure you implement the API correctly and maximize its efficiency for your specific use case.

Components

TandemDrive’s architecture consists of the following key components:

  • Main Backend: Handles all processing and data storage operations. This component powers the API’s described in this guide.

  • Console: A web interface for configuring, managing, and monitoring TandemDrive.

    For ease of use during API development, the Console allows you to quickly view an entity’s unique ID. When viewing a single entity, simply press Shift + Y to display its ID.

API Overview

Our API endpoints are grouped into two main categories:

  • Admin API

    The Admin API is the core of our system, supporting a wide range of use cases, including data synchronization, automation, and system monitoring. It provides powerful tools for managing and interacting with your TandemDrive instance.

    You can access the full specifications for this API here.

  • App API

    The App API is specifically tailored for end user applications. It provides a set of dedicated endpoints that perform actions on behalf of end users, ensuring that data access is securely managed according to the user’s permissions.

    If you are interested in accessing the App API, please contact our support team.