FastSpring Connector for ODBC
In this article you will learn how to integrate Using FastSpring Connector you will be able to connect, read, and write data from within ODBC. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to FastSpring in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from FastSpring using ODBC we first need to create a DSN (Data Source) which will access data from FastSpring. We will later be able to read data using ODBC. 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 DriverYou 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 "FastSpring" from the list of Popular Connectors. If "FastSpring" 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:
FastSpringDSNFastSpring -
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.
Steps to get FastSpring Credentials : Http [Http]
Here is how to obtain API Credentials. You might be able to use your Account Login UserId / Password but we do not reccomend using it. Instead of that use API credentials generated using the following way.- In the FastSpring App, navigate to Developer Tools > APIs > API Credentials.
- Click Create. FastSpring will automatically generate your username and password. Use this on the API connection UI
- Securely store the credentials for future reference.
- If you reset your credentials, update each stored procedure that relies on API access to prevent failed requests.
Fill in all required parameters and set optional parameters if needed:
FastSpringDSNFastSpringHttp [Http]https://api.fastspring.comRequired Parameters Optional Parameters UserName Fill in the parameter... Password Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... Your Webstore URL 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
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by FastSpring Connector
FastSpring Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description |
---|---|
Product Id |
|
Parameter | Description |
---|---|
Country Code |
|
Currency Code |
|
Parameter | Description |
---|---|
Order Id |
|
Parameter | Description |
---|---|
Order Id |
|
Parameter | Description |
---|---|
Account Id |
|
Parameter | Description |
---|---|
Account Id |
|
Parameter | Description |
---|---|
Account Id |
|
Parameter | Description |
---|---|
Subscription Id |
|
Parameter | Description |
---|---|
Quote Id |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ReportColumns |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GroupByColumns |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ReportColumns |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GroupByColumns |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
FastSpring Connector Examples for ODBC Connection
This page offers a collection of SQL 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.
Read orders [Read more...]
Read all orders
SELECT * FROM Orders
Read a single order by id [Read more...]
Read a single order by id
SELECT * FROM Orders Where Id='zzzzzzzzzz'
Read orders with date range [Read more...]
Read all orders within specific date range
SELECT * FROM Orders WITH(StartDate='2020-01-01', EndDate='2021-12-31' ) --use function like today, yesterday, yearstart, monthstart, yearstart-1y
Read orders placed in last 30 days [Read more...]
Read all orders placed in last 30 days. This hows how to use function like today, yesterday, yearstart, monthstart, yearstart-1y etc for date parameters
SELECT * FROM Orders
--WHERE Currency='USD' and TotalInPayoutCurrency>=1599
WITH(StartDate='today-30day', EndDate='today') --try today, yesterday, yearstart, yearend, monthstart, monthend, yearstart-1y so on
Read product ids [Read more...]
Read all orders
SELECT * FROM get_product_ids
Read product details [Read more...]
Read all products
SELECT * FROM Products
Read a single product by id [Read more...]
Read a single product by id
SELECT * FROM Products Where Id='some-product-id'
Read product prices [Read more...]
List product prices for specified currency or country. If you do not pass Country or Currency Parameter then all prices for all countries listed
SELECT
Product,
Country,
Currency,
Price,
PriceDisplay,
Discount2DiscountPercent,
Discount2DiscountValue,
Discount2DiscountValueDisplay,
Discount2UnitPrice,
Discount2UnitPriceDisplay,
Discount3DiscountPercent,
Discount3DiscountValue,
Discount3DiscountValueDisplay,
Discount3UnitPrice,
Discount3UnitPriceDisplay,
Discount4DiscountPercent,
Discount4DiscountValue,
Discount4DiscountValueDisplay,
Discount4UnitPrice,
Discount4UnitPriceDisplay,
Discount5DiscountPercent,
Discount5DiscountValue,
Discount5DiscountValueDisplay,
Discount5UnitPrice,
Discount5UnitPriceDisplay,
DiscountReasonEn,
DiscountPeriodCount,
AvailableStart,
AvailableEnd,
SetupFeePrice,
SetupFeePriceDisplay,
SetupFeeReasonEn
FROM ProductPrices
--WITH(Country='US') --//get prices for a specific country
--WITH(Currency='USD') --//get proces for a specific currency
Update Product [Read more...]
Update product attributes by its ID
UPDATE Products
SET
Display='Product ABCD'
, Sku='PRD-ABCD-01'
, Summary='Product Abcd **STD**'
, Description='This product can be used to call **API** supports markdown syntax'
, Action='**Action** supports markdown'
, TaxCode='DC010500'
, Image='https://zappysys.com/api/images/ZappySys-icon.png'
, FulfillmentInstructions='Thank you for shopping. **Activate** license by using our License App'
, Format='digital'
, PriceUSD='101.5'
, PriceEUR='102.5'
, PriceGBP='103.5'
, PriceCAD='104.5'
, PriceNZD='105.5'
, PriceCHF='106.5'
, PriceSEK='107.5'
, PriceCZK='108.5'
, PriceDKK='109.5'
, PricePLN='101.5'
, PriceSGD='102.5'
, PriceJPY='103.5'
, PriceCNY='104.5'
, PriceHKD='105.5'
, PriceINR='106.5'
, PriceBRL='107.5'
, PriceAUD='108.5'
, Badge='Badge-1'
, Rank=1
, Trial=14 --how many trial days
, TrialPriceUSD=10.5
--, Renew=1 --not allowed for update : Only for create (enable subscription)
, Interval='year' --allowed values: adhoc, day, week, year, only needed if you are creating a subscription
, IntervalLength=1
, IntervalCount=0
, QuantityBehavior='allow' --allowed values: allow, lock, hide
, QuantityDefault=1
, Attributes = '{"mykey-1" : "some-value-1", "mykey-2" : "some-value-2"}'
--, Fulfillments='[ { fullfillment }, { fullfillment } ... ]' --JSON fragment
Where Id='abcd'
Update multiple Products (read from CSV file) [Read more...]
Update multiple products from CSV file or other external source (e.g. Microsoft SQL Server, MySQL, Postgresql, ODBC)
UPDATE Products
SOURCE('ODBC',
--File input example (use as to match Column name allowed in Products Table to write)
--'Driver={ZappySys CSV Driver};DataPath=c:\data\products.csv',
--'select P_ID as Id,P_TAXCODE as TaxCode From $'
--Direct input example
'Driver={ZappySys CSV Driver}',
'select ''abcd'' as Id, ''DC010500'' as TaxCode UNION
select ''xyz'' as Id, ''DC010500'' as TaxCode UNION
select ''zzz'' as Id, ''DC010500'' as TaxCode
'
)
Create or Update Product (Upsert) [Read more...]
Create or Update product (Upsert)
--Insert or Update
--UPSERT INTO Products
--Insert or Update
UPSERT INTO Products
( [Id] , [Display] , [Summary]
, [Description] , [Action] , [Format]
, [Sku] , [TaxCode] , [Image]
, [Renew] , [Interval] , [IntervalLength]
, [IntervalCount] , [QuantityBehavior] , [QuantityDefault]
, [PriceUSD] , [PriceEUR] , [PriceGBP]
, [PriceCAD] , [PriceNZD] , [PriceCHF]
, [PriceSEK] , [PriceCZK] , [PriceDKK]
, [PricePLN] , [PriceSGD] , [PriceJPY]
, [PriceCNY] , [PriceHKD] , [PriceINR] , [PriceBRL] , [PriceAUD]
, [Trial]
, [TrialPriceUSD] , [TrialPriceEUR] , [TrialPriceGBP]
, [PaymentCollected] , [PaidTrial]
, [FulfillmentInstructions]
, [DateLimitsEnabled] , [CancellationInterval] , [CancellationIntervalLength]
, [SetupFeeTitle]
, [SetupFeePriceUSD] , [SetupFeePriceEUR] , [SetupFeePriceGBP]
, [Badge] , [Rank]
, [Attributes]
)
VALUES('test-std-id'
, '3Year **standard** subscription edition'
, 'summary **standard edition** _some italic_ ' -- markdown syntax allowed
, 'long description **test STD** and many more lines' --markdown syntax allowed
, 'action text with **markdown** '
, 'digital' -- e.g. digital OR physical OR digital-and-physical
, 'TEST-STD-001'
, 'DC010500'
, 'https://zappysys.com/api/images/ZappySys-icon.png'
, true , 'year' , 1
, 1 , 'allow' -- e.g. allow Or lock Or hide
, 3 --stop renewal after 3 periods
, 10.12 , 11.12 , 12.12
, 13.12 , 14.12 , 15.12
, 16.12 , 17.12 , 18.12
, 19.12 , 20.12 , 21.12
, 22.12 , 23.12 , 24.12 , 25.12 , 26.12
, 14 --how many days trial allowed
, 10.12 , 11.12 , 12.12
, 'true', true
, 'Thank you for shopping, **here are** license instructions' --markdown supported
, false, 'day', 5
, 'Setup title'
--setup fees in common currencies
, 10.50 , 11.50 , 12.50
, 'badge-1' , 1
, '{"mykey-1" : "some-value-1", "mykey-2" : "some-value-2"}' --JSON fragment
--, '[... fullfillments.. ]' --JSON fragment
)
List / Search Quotes [Read more...]
List or Search quotes. This example lists Open and Completed Quotes
SELECT * FROM Quotes
WITH(
Statuses='OPEN~COMPLETED',
--SearchFor='Test' --quote contains word "Test" in Name or blling information
-- query more status like below
--Statuses='OPEN~COMPLETED~CANCELED~EXPIRED',
)
List Product Publish Status - Public=200, Private=404 [Read more...]
List product publish status (200=Published, 404=Private)
select * from get_products_visibility
List all orders for a specific subscription [Read more...]
List all orders for a specific subscription
SELECT * FROM Orders
WHERE SubscriptionId_1='iBPfMFS6TZSxrLzSOrq8PQ'
OR SubscriptionId_2='iBPfMFS6TZSxrLzSOrq8PQ'
OR SubscriptionId_3='iBPfMFS6TZSxrLzSOrq8PQ'
ORDER BY OrderDate
Generate Subscription Report by Date, Product, Group By [Read more...]
Generate subscription report for selected group by columns, date range, products and more
SELECT *
FROM get_subscription_report
Order by transaction_date
WITH(
Country='AL~UA~US'
, ProductPaths='odbc-pp-ent-sub~odbc-pp-pro-sub~odbc-pp-std~ssis-pp-pro-sub~ssis-pp-std-sub~ssis-pp-ent-sub'
, StartDate='monthstart-1m' --or 2022-01-01
, EndDateDate='monthend+2d' --or 2022-01-01
, ReportColumns='transaction_date~transaction_month~transaction_year~activations~average_mrr~cancellations~mrr~new_subscribers~subscriptions'
, GroupByColumns='transaction_date~transaction_month~transaction_year'
)
Generate Revenue Report by Date, Product, Group By [Read more...]
Generate revenue report for selected group by columns, date range, products and more
SELECT *
FROM get_revenue_report
Order by transaction_date
WITH(
Country='AL~UA~US'
, ProductPaths='odbc-pp-ent-sub~odbc-pp-pro-sub~odbc-pp-std~ssis-pp-pro-sub~ssis-pp-std-sub~ssis-pp-ent-sub'
, StartDate='monthstart-1m' --or 2022-01-01
, EndDateDate='monthend+2d' --or 2022-01-01
, ReportColumns='Transaction_Year~Transaction_Month~Transaction_Date~Company_Name~Product_Path~Product_Units~Tax_in_USD~Transaction_Amount_in_USD~Grand_Total_In_USD'
, GroupByColumns='transaction_date~transaction_month~transaction_year'
)
Get all accounts [Read more...]
Get all accounts for your store
SELECT *
FROM Accounts
SELECT "Id"
, "ContactFirst"
, "ContactLast"
, "ContactEmail"
, "ContactCompany"
, "ContactPhone"
, "ContactSubscribed"
, "AddressLine1"
, "AddressLine2"
, "City"
, "Region"
, "RegionCustom"
, "PostalCode"
, "AddressCompany"
, "Language"
, "Country"
, "LookupGlobal"
, "Url"
, "PaymentMethods"
, "PaymentActive"
, "Orders"
, "Subscriptions"
, "Charges"
, "Subscribed"
, "TaxExemptionData"
FROM Accounts
--Use WITH clause --OR-- Key column(s) in WHERE clause
--WHERE [Id] = 'abcd'
--search by one or more parameters below
/*
WITH(
Email='X'
, CustomKey='X'
, GlobalKey='X'
, OrderID='X'
, OrderReference='X'
, SubscriptionId='X'
, Products='PROD-1,PROD-2,PROD-3'
, Refunds='true'
, SubscriptionStatus='active'
)
*/
Get all accounts with specific product orders [Read more...]
Use below query to search accounts who placed orders for specific products
SELECT * from Accounts WITH(Products='ssis-pp-pro,ssis-pp-pro-sub,ssis-pp-ent,ssis-pp-ent-sub')
Get account charges [Read more...]
Use below query to search account charges
SELECT * from AccountCharges
--search by one or more parameters below
/*
WITH(
Email='X'
, CustomKey='X'
, GlobalKey='X'
, OrderID='X'
, OrderReference='X'
, SubscriptionId='X'
, Products='PROD-1,PROD-2,PROD-3'
, Refunds='true'
, SubscriptionStatus='active'
)
*/
Get account orders by email id [Read more...]
Use below query to search for accounts and orders with search criteria
SELECT * from AccountOrders
WITH(
Email='bob@abc.com'
)
--search by one or more parameters below
/*
WITH(
Email='X'
, CustomKey='X'
, GlobalKey='X'
, OrderID='X'
, OrderReference='X'
, SubscriptionId='X'
, Products='PROD-1,PROD-2,PROD-3'
, Refunds='true'
, SubscriptionStatus='active'
)
*/
Get specific order by reference number (rather than Id) [Read more...]
Search by Order by reference (fast way). If you have less rows then use Select * FROM Orders where Reference='BIX-123' it can be faster than below appproach
SELECT * from AccountOrders WHERE Reference='BIN240202-9666-28133' WITH(OrderReference='BIN240202-9666-28133')
--or for handful rows use below way
--SELECT * from Orders WHERE Reference='BIN240202-9666-28133'
Conclusion
In this article we discussed how to connect to FastSpring in ODBC and integrate data without any coding. Click here to Download FastSpring Connector for ODBC and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download FastSpring Connector for ODBC
Documentation
More integrations
Other application integration scenarios for FastSpring
Other connectors for ODBC
Download FastSpring Connector for ODBC
Documentation
How to connect FastSpring in ODBC?
How to get FastSpring data in ODBC?
How to read FastSpring data in ODBC?
How to load FastSpring data in ODBC?
How to import FastSpring data in ODBC?
How to pull FastSpring data in ODBC?
How to push data to FastSpring in ODBC?
How to write data to FastSpring in ODBC?
How to POST data to FastSpring in ODBC?
Call FastSpring API in ODBC
Consume FastSpring API in ODBC
FastSpring ODBC Automate
FastSpring ODBC Integration
Integration FastSpring in ODBC
Consume real-time FastSpring data in ODBC
Consume real-time FastSpring API data in ODBC
FastSpring ODBC Driver | ODBC Driver for FastSpring | ODBC FastSpring Driver | SSIS FastSpring Source | SSIS FastSpring Destination
Connect FastSpring in ODBC
Load FastSpring in ODBC
Load FastSpring data in ODBC
Read FastSpring data in ODBC
FastSpring API Call in ODBC