Connect to API Data as a SQL Server Linked Server

SQL Server Linked Servers enable the SQL Server Database Engine to read data from remote data sources and execute commands against the remote database servers outside of the instance of SQL Server. Typically, linked servers are configured to enable the execution of a T-SQL statement that includes tables in another instance of SQL Server, or another database product such as Oracle. When paired with CData Connect Cloud, linked servers provides instant access to API data from your SQL Server database. This article demonstrates how to connect to your API using Connect Cloud and query API data in SQL Server Management Studio (SSMS).

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 SQL Server

Connectivity to your API from SQL Linked Servers is made possible through CData Connect Cloud. To work with API data from SQL Linked Servers, 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 SQL Server using Connect Cloud

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

1. Open Microsoft SQL Server Management Studio.
2. In the Object Explorer pane, open Server Objects, right-click Linked Servers, and select New Linked Server.
3. The New Linked Server dialogue opens. On the General page, enter the following information:
   • Enter a name for the server in the Linked server field.
   • Select the radio button Other data source and select SQL Server Native Client 11.0 as the provider.
   • In the Data source field, enter tds.cdata.com,14333
   • In the Catalog field, enter enter the Connection Name of the CData Connect Cloud data source you want to connect to (for example, API1).
4. Select the Security page. At the bottom, select the radio button labeled Be made using this security context and enter the following information:
   • Remote login - enter your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, [email protected].
   • With password - enter the PAT you generated on the Settings page.
5. Click OK to create the server.
Your linked server can now be used to access the data in the data source you specified. If you need to access data from more sources, create another linked server for each one.

Execute Queries

You can now execute queries to the your API linked server from any tool that can connect to SQL Server. An example SQL query would be: SELECT * FROM [CDATA CONNECT CLOUD].[API1].[API].[posts] We have successfully created a linked server that allows us to query API data.

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!