Authorization

Follow this guide to create a new Zuora Revenue credential that will allow Nexla to authenticate to and exchange data with your Zuora Revenue account.

Zuora Revenue

Prerequisites

Before creating a Zuora Revenue credential, you need to obtain your Zuora Revenue API Base URL, Authorization Key (Base64-encoded username:password), API User Role, and Client Name from your Zuora Revenue account. Zuora Revenue uses custom header-based authentication with Basic Authentication for token generation.

To obtain your Zuora Revenue credentials, follow these steps:

1. Sign in to your Zuora Revenue account using your administrator credentials.

2. Navigate to your Zuora Revenue account settings or API configuration in your Zuora Revenue dashboard.

3. To obtain your Zuora Revenue API Base URL, identify your Zuora Revenue environment. The Base URL depends on your Zuora Revenue environment and region. See https://www.zuora.com/developer/revpro-api/#section/Introduction/Endpoints for details about different environment URLs.

4. To obtain your Authorization Key, you need to Base64-encode your Zuora Revenue username and password in the format username:password. For example, if your username is user@example.com and your password is password123, you would encode user@example.com:password123 using Base64 encoding. The encoded value is used as the Authorization Key.

5. To obtain your API User Role, this should be the role assigned to your API user in Zuora Revenue. The default value is API Role. The API User Role is sent in the role header for API requests.

6. To obtain your Client Name, this should be the client name associated with your API user in Zuora Revenue. The default value is Default. The Client Name is sent in the clientname header for API requests.

7. Store all credentials securely, as you will need them to configure your Nexla credential. The Authorization Key is sensitive information and should be kept confidential.

The Authorization Key (Base64-encoded username:password) is used in Basic Authentication to obtain an authentication token, which is then used in subsequent API requests. The API User Role and Client Name are sent in request headers for API authentication. If your credentials are compromised, you should immediately change your password in your Zuora Revenue account settings and regenerate the Authorization Key. For detailed information about Zuora Revenue API authentication, API base URLs, and available endpoints, see the Zuora Revenue API documentation.

Create a Zuora Revenue Credential

• To create a new Zuora Revenue credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Zuora Revenue

Credential Name & Description

1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

   Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Custom Header Authentication

Zuora Revenue uses custom header-based authentication with Basic Authentication for token generation. The Authorization Key (Base64-encoded username:password) is used to obtain an authentication token, and the API User Role and Client Name are sent in request headers.

2. Enter your Zuora Revenue API Base URL in the Zuora Revenue API Base URL field. This should be the Base URL for your Zuora Revenue Cloud API. The Base URL depends on your Zuora Revenue environment and region. See https://www.zuora.com/developer/revpro-api/#section/Introduction/Endpoints for details about different environment URLs. The Base URL determines which Zuora Revenue environment will be accessed.

3. Enter your Authorization Key (Use Base64Encode(username:password)) in the Authorization Key (Use Base64Encode(username:password)) field. This should be your Zuora basic authorization token, set to Base64Encode(username:password). For example, if your username is user@example.com and your password is password123, you would encode user@example.com:password123 using Base64 encoding. The Authorization Key is used in Basic Authentication to obtain an authentication token for subsequent API requests. The Authorization Key is sensitive information and must be kept confidential.

4. Enter your API User Role in the API User Role field. This should be the Zuora API Role assigned to your API user. The default value is API Role. The API User Role is sent in the role header for API requests.

5. Enter your Client Name in the Client Name field. This should be the Zuora API Client Name associated with your API user. The default value is Default. The Client Name is sent in the clientname header for API requests.

   Your Zuora Revenue credentials (Base URL, Authorization Key, API User Role, Client Name) can be found in your Zuora Revenue account settings. The Base URL depends on your Zuora Revenue environment and region. The Authorization Key must be Base64-encoded in the format username:password. The API User Role and Client Name are sent in request headers for API authentication.

   If your credentials are compromised, you should immediately change your password in your Zuora Revenue account settings and regenerate the Authorization Key. The credentials provide access to your Zuora Revenue account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

   For detailed information about Zuora Revenue API authentication, API base URLs, and available endpoints, see the Zuora Revenue API documentation.

Save the Credential

1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.