ADO.NET Provider for Zuora

Build 24.0.9060

Establishing a Connection

Connecting to Zuora

In order to create a valid connection with Zuora, you must configure the Tenant property. Choose the Tenant value that matches your account configuration. Available options:

  • USProduction: Requests sent to https://rest.zuora.com. (default)
  • USAPISandbox: Requests sent to https://rest.apisandbox.zuora.com"
  • USPerformanceTest: Requests sent to https://rest.pt1.zuora.com"
  • EUProduction: Requests sent to https://rest.eu.zuora.com"
  • EUSandbox: Requests sent to https://rest.sandbox.eu.zuora.com"

After you configure the Tenant you must create a custom OAuth application to generate a token. This is a simple one-time operation. For further information, see Creating a Custom OAuth Application.

Authenticating to Zuora

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must create a custom application to get and refresh the OAuth access token. After you do that, you are ready to connect.

Set the following connection properties:

  • OAuthClientId: the client Id assigned when you registered your application.
  • OAuthClientSecret: the client secret that was assigned when you registered your application.
  • CallbackURL: the redirect URI that was defined when you registered your application.
When you connect, the provider opens Zuora's OAuth endpoint in your default browser.

Log in and grant permissions to the application. The provider then completes the OAuth process:

  1. The provider obtains an access token from Zuora and uses it to request data.
  2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.
  3. When the access token expires, the provider refreshes the access token automatically.

Web Applications

To authenticate from the web with the credentials for a custom OAuth application, you must register a custom OAuth application with Zuora. You can then use the provider to get and manage the OAuth token values.

This section describes how to get the OAuth access token, and how to have the driver refresh the OAuth access token automatically, and how to refresh the OAuth access token manually.

Get an OAuth access token:

To obtain the OAuthAccessToken set the following connection properties:

  • OAuthClientId: the client Id in your application settings.
  • OAuthClientSecret: the client secret in your application settings.

To complete the OAuth exchange, call stored procedures as follows:d

  1. Log in and authorize the web application. You are redirected back to the callback URL.
  2. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you obtain the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic refresh of the OAuth access token:

If you want the provider to refresh the OAuth access token automatically, do the following:

Before connecting to data for the first time, set the following connection parameters:

  • InitiateOAuth : REFRESH.
  • OAuthClientId: the client Id in your application settings.
  • OAuthClientSecret: the client secret in your application settings.
  • OAuthAccessToken: the access token returned by GetOAuthAccessToken.
  • OAuthSettingsLocation: the path where you want the provider to save OAuth values that persist across connections.

On subsequent data connections, set the following connection parameters:

  • InitiateOAuth
  • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set the following connection properties:

    • OAuthClientId: the Client Id in your application settings.
    • OAuthClientSecret: the Client Secret in your application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to authenticate via OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

  • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
  • Option 2: Install the provider on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Do the following:

  1. Set the following properties:
    • InitiateOAuth: OFF.
    • OAuthClientId: the client Id assigned when you registered your application.
    • OAuthClientSecret: the client secret assigned when you registered your application.
  2. Log in and grant permissions to the provider. You are redirected to the redirect URI.
  3. Record the code parameter that is appended to the redirect URI. You will use it later, when you set up the OAuthVerifier connection property.
  4. To exchange the OAuth verifier code for OAuth refresh and access tokens, set the following connection properties, which provide the OAuth authentication values:
    • InitiateOAuth: REFRESH.
    • OAuthVerifier: the noted verifier code (the value of the code parameter in the redirect URI).
    • OAuthClientId: the client Id in your custom OAuth application settings.
    • OAuthClientSecret: the client secret in the custom OAuth application settings.
    • OAuthSettingsLocation: persist the encrypted OAuth authentication values to the specified file.
  5. Test the connection to generate the OAuth settings file, then re-set the following properties to connect:
    • InitiateOAuth: REFRESH.
    • OAuthClientId: the client Id assigned when you registered your application.
    • OAuthClientSecret: the client secret assigned when you registered your application.
    • OAuthSettingsLocation: the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Before connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as previously described above, in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is "OAuthSettings.txt".

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set the following connection properties:

  • InitiateOAuth: REFRESH.
  • OAuthClientId: the client Id assigned when you registered your application.
  • OAuthClientSecret: the client secret assigned when you registered your application.
  • OAuthSettingsLocation: the path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the provider.

Selecting a Zuora Service

We utilize two Zuora services: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

DataQuery

The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

Limitations

  • The maximum number of input records per table after filters have been applied: 1,000,000
  • The maximum number of output records: 100,000
  • The maximum number of simultaneous queries submitted for execution per tenant: 5
  • The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
  • The maximum processing time for each query in hours: 1
  • The maximum size of memory allocated to each query in GB: 2
  • The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

Selecting a Zuora Service

We utilize two Zuora services: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

DataQuery

The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

Limitations

  • The maximum number of input records per table after filters have been applied: 1,000,000
  • The maximum number of output records: 100,000
  • The maximum number of simultaneous queries submitted for execution per tenant: 5
  • The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
  • The maximum processing time for each query in hours: 1
  • The maximum size of memory allocated to each query in GB: 2
  • The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

AQuADataExport

AQuA API export is designed to export all the records for all the objects ( tables ). AQuA query jobs have the following limitations:

Limitations

  • If a query in an AQuA job is executed longer than 8 hours, this job will be killed automatically.
  • The killed AQuA job can be retried three times before returned as failed.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060