Connect to API Data from HeidiSQL

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with CData Connect Cloud, HediSQL reach extends to include access to live API data. This article demonstrates how to connect to your API using Connect Cloud and query API data in HeidiSQL.

CData Connect Cloud provides a pure SQL Server interface for your API, allowing you to query data from your API without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to your API, leveraging server-side processing to return the requested API data quickly.

Configure your API Connectivity for HeidiSQL

Connectivity to your API from HeidiSQL is made possible through CData Connect Cloud. To work with API data from HeidiSQL, we start by creating and configuring a your API connection.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "API" from the Add Connection panel
3. Enter the necessary authentication properties to connect to your API.

   To connect to your API, configure the following properties on the Global Settings page:

   • In Authentication, select the Type and fill in the required properties
   • In Headers, add the required HTTP headers for your API
   • In Pagination, select the Type and fill in the required properties

   After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

   1. Click "+ Add"
   2. Set the Name for the table
   3. Set Request URL to the API endpoint you wish to work with
   4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
   5. (Optional) In Headers, add the required HTTP headers for the API endpoint
   6. In Table Data click " Configure"
   7. Review the response from the API and click "Next"
   8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next"
   9. Preview the tabular model of the API response and click "Confirm"
4. Click Create & Test
5. Navigate to the Permissions tab in the Add your API Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to your API from HeidiSQL using Connect Cloud

To establish a connection from HeidiSQL to the CData Connect Cloud Virtual SQL Server API, follow these steps.

Create a new HeidiSQL Session

1. In the Session Manager, select New in the bottom-left
2. Give the new session a descriptive name, e.g. Connect-Cloud-your API

Configure a SQL Server Connection to Connect Cloud

1. In the session settings, set the Network type to Microsoft SQL Server (TCP/IP)
2. The Library DLL should automatically update to MSOLEDBSQL
3. Set the Hostname/IP to tds.cdata.com
4. Set the User to your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, [email protected]
5. Set the Password to your PAT created in Connect Cloud in the previous section.
6. Set the Port to 14333

Query your API from HeidiSQL

1. In the database listing on the left, find your connection to your API configured earlier.
2. Expand this connection to view individual tables or data objects present within your API.
3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables

Get CData Connect Cloud

To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect Cloud today!