How to read OData data in ODBC application?
In this section we will learn how to configure and use OData Connector in the API Driver to extract data from the OData.
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from using we first need to create a DSN (Data Source) which will access data from . We will later be able to read data using . Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API Driver
You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
When the Configuration window appears give your data source a name if you haven't done that already, then select "OData" from the list of Popular Connectors. If "OData" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ODataDSNOData
-
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). More info is available in the Authentication section.
Fill in all required parameters and set optional parameters if needed:
ODataDSNODataNo Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... IgnoreSSLCertificateErrors Fill in the parameter... SslVersion Fill in the parameter... 
Fill in all required parameters and set optional parameters if needed:
ODataDSNODataWindows Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters Optional Parameters
Fill in all required parameters and set optional parameters if needed:
ODataDSNODataBasic Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters UserName Fill in the parameter... Password Fill in the parameter... Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... IgnoreSSLCertificateErrors Fill in the parameter... SslVersion Fill in the parameter...
Fill in all required parameters and set optional parameters if needed:
ODataDSNODataNTLM Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters UserName (i.e. Domain\UserName) Fill in the parameter... Password Fill in the parameter... Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... IgnoreSSLCertificateErrors Fill in the parameter... SslVersion Fill in the parameter...
Fill in all required parameters and set optional parameters if needed:
ODataDSNODataToken Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters Token Fill in the parameter... Optional Parameters AuthScheme Fill in the parameter... AuthHeader Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... IgnoreSSLCertificateErrors Fill in the parameter... SslVersion Fill in the parameter...
Fill in all required parameters and set optional parameters if needed:
ODataDSNODataOAuth Connection for OData API [OAuth]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters Optional Parameters GrantType Fill in the parameter... OAuthVersion Fill in the parameter... ClientId Fill in the parameter... ClientSecret Fill in the parameter... UserName Fill in the parameter... Password Fill in the parameter... Scope Fill in the parameter... AuthUrl Fill in the parameter... TokenUrl Fill in the parameter... ReturnUrl Fill in the parameter... ExtraAttributesForTokenRequest Fill in the parameter... ExtraAttributesForAuthRequest Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... IgnoreSSLCertificateErrors Fill in the parameter... SslVersion Fill in the parameter... 
-
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Video instructions
Reading data from client application
- Firstly, to get data from ODBC data source based on ZappySys ODBC driver, in your client application, you would need to connect to ODBC source and then from the list select the data source.
-
Finally, to read the data just read tables/views in your app or enter a SQL statement to extract data, e.g.:
SELECT * FROM [$parent.name$]
OData Connector Examples
The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the OData API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from OData.
Click here to find more OData Connector examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Consume Data inside your App / Programming Language
Once you know how to load data from OData Connector, you can click on one of the below links to learn the steps how to consume data inside your App / Programming Language from OData Connector.ODBC inside ETL / Reporting / BI Tools
- Power BI
- Tableau
- Excel
- Informatica PowerCenter
- QlikView
- SQL Server / Linked Server
- SSRS (SQL Server Reporting Services)
ODBC inside Programming Languages
Key features of the ZappySys API Driver include:
The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.
Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within OData without requiring extensive technical expertise or programming knowledge.
Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within OData.
Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from OData and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.
Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the OData API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.
Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.
Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from OData, enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.
Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with OData, providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.