Building a Custom API Connector for SSAS Read / write Custom API data in SSAS without coding. In this article you will learn how to quickly and efficiently integrate Custom API data in SSAS without coding. We will use high-performance Custom API Connector to easily connect to Custom API and then access the data inside SSAS. Let's follow the steps below to see how we can accomplish that! Download Documentation Building a Custom API Connector for SSAS is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Connect to Custom API Connector in other apps Custom API Connector for SSIS Custom API Connector for SQL Server Custom API Connector for Power BI Custom API Connector for SSRS Custom API Connector for Informatica Custom API Connector for MS Access Custom API Connector for MS Excel Custom API Connector for C# Custom API Connector for Python Custom API Connector for JAVA Custom API Connector for Tableau Custom API Connector for SAP Crystal Reports Custom API Connector for Azure Data Factory (Pipeline) Custom API Connector for Azure Data Factory (SSIS) Custom API Connector for Talend Studio Custom API Connector for UiPath Custom API Connector for PowerShell Custom API Connector for ODBC

Create Custom API Connector

First of all, you will have to create your own API connector. For demonstration purposes, in this section we will create a simple Hello-World API connector that calls ZappySys Sandbox World API endpoint https://sandbox.zappysys.com/api/world/hello. When developing your Custom API Connector, just replace it with your real API method/endpoint. Let's dive in and follow these steps:

1. Open ODBC Data Sources (x64):

   

2. Create a User data source (User DSN) based on ZappySys JSON Driver

   ZappySys JSON Driver

   

3. Once the data source configuration window opens, enter this URL into the text box:

   https://sandbox.zappysys.com/api/world/hello

   

4. Then go to the Preview tab and try to say "Hello!" to the World!

   

5. Since the test is successful, you are ready to create the Hello-World Connector:

   

6. The API Connector File Wizard opens, click Next:

   

7. Leave the default option, and click Next again:

   

8. Just click Next in the next window:

   

9. Let's give our new custom connector a name it deserves:

   

10. Then just click Next in the Connection Types window:

    

11. Let's name the hello endpoint (it deserves a name too!):

    

12. When the next window opens, delete the default table (we won't need it for now):

    

13. Finally, specify a path, where you want to save the newly created API Connector:

    

Create Data Source in ZappySys Data Gateway based on API Driver

1. Download and install ODBC PowerPack.

2. Search for gateway in start menu and Open ZappySys Data Gateway:
   

3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
   

4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

   CustomApiConnectorDSN

   
   

5. When the Configuration window appears give your data source a name if you haven't done that already. Then set the path to your created Custom API Connector (in the example below, we use Hello-World Connector). Finally, click Continue >> to proceed:

   

6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). Check your Custom API reference for more information on how to authenticate.

   

7. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - Custom API Connector

   Read / write Custom API data in SSAS without coding.

   CustomApiConnectorDSN

   

8. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in SSAS to retrieve data from Custom API Connector. Hit OK button to use this query in the next step.

   SELECT * FROM Orders

   
   Some parameters configured in this window will be passed to the Custom API Connector API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

9. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in SSAS:

   

   ZappySys API Driver - Custom API Connector

   Read / write Custom API data in SSAS without coding.

   CustomApiConnectorDSN

   SELECT * FROM Orders

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Custom API Connector API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Custom API Connector servers).

10. Click OK to finish creating the data source.

Read Custom API Connector data in SSAS cube

With the data source created in the Data Gateway (previous step), we're now ready to read Custom API Connector data in an SSAS cube. Before we dive in, open Visual Studio and create a new Analysis Services project. Then, you're all set!

Create data source based on ZappySys Data Gateway

Let's start by creating a data source for a cube, based on the Data Gateway's data source we created earlier. So, what are we waiting for? Let's do it!

1. Create a new data source:
2. Once a window opens, select Create a data source based on an existing or new connection option and click New...:
3. Here things become a little complicated, but do not despair, it's only for a little while. Just perform these little steps:
   • Select Native OLE DB\SQL Server Native Client 11.0 as provider.
   • Enter your Server name (or IP address) and Port, separated by a comma.
   • Select SQL Server Authentication option for authentication.
   • Input User name which has admin permissions in the ZappySys Data Gateway.
   • In Database name field enter the same data source name you use in the ZappySys Data Gateway.
   • Hopefully, our hard work is done, when we Test Connection.
   CustomApiConnectorDSN

   CustomApiConnectorDSN

   
   If SQL Server Native Client 11.0 is not listed as Native OLE DB provider, try using these:

   • Microsoft OLE DB Driver for SQL Server
   • Microsoft OLE DB Provider for SQL Server
4. Indeed, life is easy again:

Add data source view

We have data source in place, it's now time to add a data source view. Let's not waste a single second and get on to it!

1. Start by right-clicking on Data Source Views and then choosing New Data Source View...:
2. Select the previously created data source and click Next:
3. Ignore the Name Matching window and click Next.
4. Add the tables you will use in your SSAS cube:
   For cube dimensions, consider creating a Virtual Table in the Data Gateway's data source. Use the DISTINCT keyword in the SELECT statement to get unique values from the facts table, like this:

   SELECT DISTINCT Country FROM Customers

   For demonstration purposes we are using sample tables which may not be available in Custom API Connector.
5. Review your data source view and click Finish:
6. Add the missing table relationships and you're done!

Create cube

We have a data source view ready to be used by our cube. Let's create one!

1. Start by right-clicking on Cubes and selecting New Cube... menu item:
2. Select tables you will use for the measures:
3. And then select the measures themselves:
4. Don't stop and select the dimensions too:
5. Move along and click Finish before the final steps:
6. Review your cube before processing it:
7. It's time for the grand finale! Hit Process... to create the cube:
8. A splendid success!

Execute MDX query

The cube is created and processed. It's time to reap what we sow! Just execute an MDX query and get Custom API Connector data in your SSAS cube:

Conclusion

In this article we showed you how to connect to Custom API in SSAS and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Custom API Connector, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download Custom API Connector for SSAS and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Custom API Connector for SSAS Documentation

More integrations

Other connectors for SSAS

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for Custom API

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Common Searches: