Skip to content

Latest commit

 

History

History

zuora-billing-adapter

README.md

Zuora Billing adapter

Zuora Billing read-only adapter for salto.io

Salto helps you keep track of the main configuration entities in the Zuora Billing module, including the product catalog and rate plans, workflows, custom and standard objects, as well as settings related to accounting and billing.

We do this using the Zuora REST API.

Known limitations:

  • Some parts of the configuration may not yet be accessible via API on your tenant. If you are unable to see something that you think should be available, we are happy to help understand what needs to be enabled (with help from the Zuora support team).
  • Zuora has many different feature combinations, and we have not yet covered all of them. If you see something missing and would like to make it available, contact us and we will do our best to support it.

Connecting to your Zuora account

Salto authenticates with Zuora using OAuth v2.0. If you do not have one already, follow the steps to:

  • Create an API user role and an API user
  • Add an OAuth client for your API user - by going to Administration -> Manage Users -> (choose the user) -> OAuth Clients -> create (and keep the client ID and secret shown on screen)
    • Note: If you are using an entity with multiple tenants, make sure to select only a single entity under Accessible Entities when defining the OAuth client

When logging in with Salto, you will be asked to provide:

  • The OAuth client ID and secret
  • The subdomain for your account (can be copied from the URL in the browser - for example, for https://sandbox.na.zuora.com/ the subdomain is sandbox.na)

Zuora Swaggers

The Zuora Billing adapter relies on the Zuora Billing REST API swagger definitions. To make sure the adapter does not unexpectedly break due to a change in the swagger, we use the Swaggers Repository, which contains the latest version that this adapter was tested on.

E2E tests

E2E tests need real Zuora credentials to run.

Using a specific set of credentials

Add the following environment variables to bash_profile:

export ZA_BASE_URL='XXXX'
export ZA_CLIENT_ID='XXXX'
export ZA_CLIENT_SECRET='XXXX'

Using the shared credentials pool

The credentials pool can be used to run the E2E tests concurrently on multiple Zuora accounts.

The pool is used if the ZA_ environment variables are not defined. You can also force its use by defining the environment variable USE_CRED_POOL=1.

AWS credentials for the pool

The pool uses Amazon DynamoDB, and needs read/write/list permissions for the e2e_permissions table.

Make sure your AWS credentials are set, e.g, as environment variables:

export AWS_ACCESS_KEY_ID='XXXX'
export AWS_SECRET_ACCESS_KEY='XXXX'

Managing the pool using CLI

To add your credentials to the pool, use the cred-store CLI located at the e2e_test directory of the project:

./e2e_test/cred_store register zuora_billing 'my-credentials-id' --baseURL='https://rest.SANDBOX_SUBDOMAIN.zuora.com' --clientId='MYCLIENTID' --clientSecret='MYCLIENTSECRET'

Enter --help to see other uses for the cred-store utility - listing, removing and managing sets of credentials.