Zoomdata Version

Getting Started with the SDK

Overview

The Zoomdata Software Development Kit (SDK) is a set of tools to help software developers extend Zoomdata's capabilities and embed them into custom and third-party applications. It is intended for use by software developers.

Contents

What Can I Do with the SDK?

The Zoomdata SDK allows you to extend and embed Zoomdata's data analytics server to fit your own particular needs. You can:

  • use Zoomdata data in your own web application
  • embed a Zoomdata chart in your own web application
  • create a custom chart to use in Zoomdata or your own web application
  • use Zoomdata administrative controls in your own application
  • use the OAuth 2.0 protocol to secure your app's use of Zoomdata

back to top

What's in the Box?

The Zoomdata SDK is a toolkit for extending Zoomdata's native capabilities and for embedding Zoomdata analytics in your own application. It includes:

  • Javascript client (the application framework) - to query data and embed charts from Zoomdata in a custom web application
  • REST APIs (the administrative framework) - to programmatically manage Zoomdata's administrative features, including sources, groups and users, security, and more.
  • Visualization Framework - to add new charts to Zoomdata gallery
  • Samples - working code to help you see the various APIs in action
  • How-to guides - to provide steps for different common tasks
  • Reference documentation - for easily looking up various object definitions and methods.

back to top

What Do I Need to Get Started?

The Zoomdata SDK is a toolkit to augment your own skills and tools as you build your own applications and extend Zoomdata itself. To get started, you need:

  • access to a Zoomdata server
  • administrative access to one or more accounts on the server, or ideally supervisor access to the server itself
  • some data
  • competence with Javascript and web development principles, if you want to use Zoomdata's client library or visualization framework
  • an understanding of REST APIs and web asynchronous processes, if you intend to use Zoomdata's REST APIs

back to top

Where Do I Begin?

How you get started with Zoomdata depends upon what you want to do.

I want to...

customize the way the Zoomdata app looks: the login screen, the logo, and so on. You do not need the SDK to make customizations to the Zoomdata application. For information about customizing the look and feel of the Zoomdata app, see Customizing the Zoomdata User Interface .
create dashboards of charts. You do not need the SDK to create dashboards of Zoomdata charts. For information about creating dashboards in the Zoomdata application, see Creating and Interacting with Dashboards (v2.2 GA) .
add a new chart to the Zoomdata gallery of charts. The Zoomdata SDK includes a Javascript framework for creating or importing charts and adding them to those provided by Zoomdata. For more information, see Creating a Custom Chart Template .
modify an existing Zoomdata chart's functionality. The Zoomdata SDK includes templates for its charts. You can create a new chart from one of these templates and modify the template to your own specifications. For more information, see Creating a Custom Chart Template .
embed a chart in my own custom web application. The SDK includes a Javascript client library that allows you to embed a chart in your web app. For more information, see Embedding a Visualization (Chart) in a Web App (v2.2 GA) .
use data from Zoomdata in my own custom web application. The SDK includes a Javascript client library that allows you to use data from Zoomdata in your web app. For more information, see Using a Data Query .
manage Zoomdata users, accounts, data sources, etc., in my own custom application or script. The SDK includes a large number of REST methods that allow you administer the metadata of your Zoomdata server in your own application or using curl or a REST client. For more information, see Administrative Framework Overview .
use the OAuth 2.0 protocol to securely access Zoomdata functionality in my own application. The SDK provides a workflow for using the OAuth 2.0 protocol in your custom app. For more information, see Implementing OAuth 2.0 with Zoomdata .

back to top

Was this topic helpful?