Building a Custom API Connector for PowerShell

Read / write Custom API data in PowerShell without coding.

In this article you will learn how to quickly and efficiently integrate Custom API data in PowerShell without coding. We will use high-performance Custom API Connector to easily connect to Custom API and then access the data inside PowerShell.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Building a Custom API Connector for PowerShell 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.

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:

Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ZappySys JSON Driver:

ZappySys JSON Driver
Once the data source configuration window opens, enter this URL into the text box:

https://sandbox.zappysys.com/api/world/hello
Then go to the Preview tab and try to say "Hello!" to the World!
Since the test is successful, you are ready to create the Hello-World Connector:
The API Connector File Wizard opens, click Next:
Leave the default option, and click Next again:
Just click Next in the next window:
Let's give our new custom connector a name it deserves:
Then just click Next in the Connection Types window:
Let's name the hello endpoint (it deserves a name too!):
When the next window opens, delete the default table (we won't need it for now):
Finally, specify a path, where you want to save the newly created API Connector:

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Custom API using PowerShell we first need to create a DSN (Data Source) which will access data from Custom API. We will later be able to read data using PowerShell. Perform these steps:

Download and install ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ZappySys API Driver:

ZappySys API Driver
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:
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.
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 PowerShell without coding.

CustomApiDSN
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 PowerShell 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.
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 PowerShell:
ZappySys API Driver - Custom API

Read / write Custom API data in PowerShell 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).
Click OK to finish creating the data source.

Video Tutorial

Read Custom API data in PowerShell

Sometimes, you need to quickly access and work with your Custom API data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:

Viewing data in a terminal

Quickly peek at Custom API data
Monitor data constantly in your console

Saving data to a file

Export data to a CSV file so that it can be sliced and diced in Excel
Export data to a JSON file so that it can ingested by other processes
Export data to an HTML file for user-friendly view and easy sharing
Create a schedule to make it an automatic process

Saving data to a database

Store data internally for analysis or for further ETL processes
Create a schedule to make it an automatic process

Sending data to another API

Integrate data with other systems via external APIs

In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!

Reading individual fields

Open your favorite PowerShell IDE (we are using Visual Studio Code).

Use this code snippet to read the data using CustomApiDSN data source:

"DSN=CustomApiDSN"

Read API data with PowerShell using ODBC DSN in Visual Code

For your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=CustomApiDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
$format = "{0}`t{1}`t{2}`t{3}"

# Display data in the console
foreach ($row in $table.Rows)
{
    # Construct line based on the format and individual Custom API fields
    $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
    Write-Host $line
}

Access specific Custom API table field using this code snippet:

$field = $row["ColumnName"]

You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.

For demonstration purposes we are using sample tables which may not be available in Custom API.

To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
```
. 'C:\Users\john\Documents\dsn.ps1'
```

Retrieving all fields

However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:

"DSN=CustomApiDSN"

Read all API columns from ODBC data source in PowerShell

Again, for your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=CustomApiDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Display data in the console
foreach ($row in $table.Rows) {
    $line = ""
    foreach ($column in $table.Columns) {
        $value = $row[$column.ColumnName]

        # Let's handle NULL values
        if ($value -is [DBNull])
        {
            $value = "(NULL)"
        }
        $line += $value + "`t"
    }
    Write-Host $line
}

You can limit the numbers of lines to retrieve by using a LIMIT keyword in the query, e.g.:

SELECT * FROM Customers LIMIT 10

Using a full ODBC connection string

In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:

Open ODBC data source configuration and click Copy settings:

ZappySys API Driver - Configuration [Version: 2.0.1.10418]

ZappySys API Driver - Custom API

Read / write Custom API data in PowerShell without coding.

CustomApiDSN
The window opens, telling us the connection string was successfully copied to the clipboard:
Then just paste the connection string into your script:
You are good to go! The script will execute the same way as using a DSN.

Have in mind that a full connection string has length limitations.

Proceed to the next step to find out the details.

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

Open your ODBC data source.
Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
Continue by pasting the copied connection string into a newly created file and save it.
Finally, the last step! Just construct a shorter ODBC connection string using this format:
```
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
```
Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.

This feature requires ODBC PowerPack v1.9.0 or later.

Write Custom API data to a file in PowerShell

Save data to a CSV file

Export data to a CSV file so that it can be sliced and diced in Excel:

# Configure connection string and query
$connectionString = "DSN=CustomApiDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force

Save data to a JSON file

Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force

Save data to an HTML file

Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force

Check useful PowerShell cmdlets other than ConvertTo-Csv, ConvertTo-Json, and ConvertTo-Html for other data manipulation scenarios.

Centralized data access via Data Gateway

In some situations, you may need to provide Custom API data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

Centralized data access
The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
Centralized access control
Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

	Data Gateway	Local ODBC data source
Simple configuration
Installation	Single machine	Per machine
Connectivity	Local and remote	Local only
Connections limit	Limited by License	Unlimited
Central data access
Central access control
More flexible cost

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Custom API, and to create an ODBC data source to connect to Data Gateway in PowerShell.

Let's not wait and get going!

Creating Custom API data source in Gateway

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

Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:
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
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
When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.
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.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from PowerShell. To achieve that, let's perform these steps:

Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

ODBC Driver 17 for SQL Server

If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.
Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

GatewayDSN

localhost,5000

Make sure you separate the hostname and port with a comma, e.g. localhost,5000.
Proceed with authentication part:
- Select SQL Server authentication
- In Login ID field enter the user name you used in Data Gateway, e.g., john
- Set Password to the one you configured in Data Gateway
Then set the default database property to CustomApiDSN (the one we used in Data Gateway):

CustomApiDSN
Continue by checking Trust server certificate option:
Once you do that, test the connection:
If connection is successful, everything is good:
Done!

We are ready to move to the final step. Let's do it!

Accessing data in PowerShell via Data Gateway

Finally, we are ready to read data from Custom API in PowerShell via Data Gateway. Follow these final steps:

Go back to PowerShell.

Use this code snippet to read the data using GatewayDSN data source:

"DSN=GatewayDSN"

For your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=GatewayDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
$format = "{0}`t{1}`t{2}`t{3}"

# Display data in the console
foreach ($row in $table.Rows)
{
    # Construct line based on the format and individual Custom API fields
    $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
    Write-Host $line
}

Access specific Custom API table field using this code snippet:

$field = $row["ColumnName"]

You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.

For demonstration purposes we are using sample tables which may not be available in Custom API.

Read the data the same way we discussed at the beginning of this article.
That's it!

Now you can connect to Custom API data in PowerShell via the Data Gateway.

If you are asked for authentication details, use Database authentication or SQL Authentication option and enter credentials you used when configuring Data Gateway, e.g. john and your password.