Zuora
- 09 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Zuora
- Updated on 09 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Zuora API
Configuration Parameters
Any instance where an entry in the below configuration has a leading $ represents a parameter that needs to be replaced with a static value.
Parameters in this document:
- $client_id and $client_secret - The Client ID and Client Secret will be used to authenticate calls to the Zuora API. These tokens are associated with an Authenticated User in Zuora, and can be exchanged for the access token that will be used to make API calls. Documentation on how to Authenticate a User can be found here.
- $access_token - The Access Token will provide access to the Zuora API. Documentation on how to exchange a Client ID and Client Secret for an Access Token can be found here.
- $endpoint - The Endpoint represents the data that you would like to ingest into Panoply from the Zuora API.
API Resources
For a list of API Resources available for Zuora, please refer to the list of endpoints found here, where each endpoint can be seen as a dropdown on the lefthand menu, starting with the Products section. The endpoint value found here should be used as the value for the $endpoint parameter explained above.
Connector configuration
- Base url: https://rest.sandbox.eu.zuora.com/v2/$endpoint
- Method: GET
- URL Parameters: page_size=99
- Headers: {"Content-Type":"application/json"}
- Destination: zuora_$endpoint
Destination table naming convention is ultimately up to you as the data owner. One common structure used for this API is zuora_$endpoint (e.g. when collecting the Products resource, using the Destination of zuora_products)
Authorization
- Authorization: Bearer Token
- Token: {access_token}
Variables
| Variable name | Variable value |
|---|---|
| client_id | $client_id |
| client_secret | $client_secret |
| access_token | $access_token |
Pagination
- Enable:
- Get next page value: Dynamic (next page value included in the response)
- Next page key in response: next_page
- Use next page value: As a URL parameter value
- URL/body key: cursor
- Stop iterating when: No next page in response
Refresh access token
- Enable:
- URL: https://rest.sandbox.eu.zuora.com/oauth/token
- Method: POST
- POST data: {"client_id":"{client_id}","client_secret":"{client_secret}","grant_type":"client_credentials"}
- Headers: {"Content-Type":"application/x-www-form-urlencoded"}
- Access Token response key: access_token
- Use Bearer authentication:
- Error status codes: 401; 403
Advanced Settings
- Data key: data
Was this article helpful?
.png)