Building a Custom API Connector for SSRS

Video Tutorial - Integrate Custom API data in SSRS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

• How to download and install the required PowerPack for Custom API integration in SSRS
• How to configure the connection for Custom API
• Features of the ZappySys API Driver (Authentication / Query Language / Examples / Driver UI)
• How to use the Custom API in SSRS

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 Data Gateway based on ZappySys API Driver

In this section we will create a data source for Custom API in Data Gateway. Let's follow these steps to accomplish that:

1. Download and install ODBC PowerPack.

2. Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:

   

3. Go to Users tab and follow these steps to add a Data Gateway user:

   • Click Add button
   • In Login field enter username, e.g., john
   • Then enter a Password
   • Check Is Administrator checkbox
   • Click OK to save
   

4. Now we are ready to add a data source:

   • Click Add button
   • Give Datasource a name (have it handy for later)
   • Then select Native - ZappySys API Driver
   • Finally, click OK
   CustomApiDSN

   ZappySys API Driver

   

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

   Read / write Custom API data in SSRS without coding.

   CustomApiDSN

   

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 SSRS to retrieve data from Custom API. 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, 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 SSRS:

   

   ZappySys API Driver - Custom API

   Read / write Custom API data in SSRS without coding.

   CustomApiDSN

   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 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 servers).

10. Click OK to finish creating the data source.

11. Very important step. Now, after creating or modifying the data source make sure you:

    • Click the Save button to persist your changes.
    • Hit Yes, once asked if you want to restart the Data Gateway service.

    This will ensure all changes are properly applied:

    
    Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Read data in SSRS from ZappySys Data Gateway

1. Open Visual Studio and create a new SSRS project.

2. Then add a new Shared Data Source (you can create a non-shared data source inside report too):

   

3. Continue with creating the Shared Data Source. Select Microsoft SQL Server as Type and hit Build button to proceed further:

   

4. Once a window opens, configure it similarly. Configure "CustomApiDSN" as database name. Finally, hit Test Connection and OK:

   CustomApiDSN

   

5. Another window opens, and it should look similarly to this one below which ends the creation of a Data Source:

   DataSource=localhost,5000;Initial Catalog=CustomApiDSN

   

6. Now it's time to create a Dataset. If you don't have a report created, in one of the wizard's steps it will look like this:

   SELECT * FROM Orders

   

7. Finally, once you complete the report, similar results will show up:

   

Passing Parameters to SSRS Report / Filter data

If you want to parameterize your report, then refer to this article

Conclusion

In this article we showed you how to connect to Custom API in SSRS and integrate data without any coding, saving you time and effort.

We encourage you to download Custom API Connector for SSRS 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 SSRS Documentation

More integrations

Other connectors for SSRS

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

Dropbox

ElasticSearch

FastSpring

Gmail

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Search Console

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Parquet (DuckDB)

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

Informatica

MS Access

MS Excel

SSAS

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC