Downloading the Utility
The utility can be downloaded from the Precision Bridge website, on the utilities page:
https://precisionbridge.net/utilities/
Using the Utility
Note that to use the utility under a Subscription Licence, your Precision Bridge Licence must explicitly include the Zendesk instance you will be using as the source. See Licencing Precision Bridge for more information. The utility will not be enabled if it is not licenced, and you will only be able to run the utility using connections explicitly defined in your licence.
The Zendesk utility is an executable, the output of which is an output of a collection of CSV files which can be used as a source with the CSV adaptor.
It fetches data from the Zendesk API, loads rows into memory, and writes to CSV files in chunks of 1000 rows at a time.
The utility should be run from the command line. It takes five arguments:
-
The api root for the zendesk server to connect to, e.g.
https://<domain>.zendesk.com/api/v2/ - The username of the admin account to connect with, followed by ‘/token’, e.g.
user@precisionbridge.net/token - An API token for this user. API tokens are managed under Admin Centre -> Apps and Integrations -> APIs -> Zendesk API.
- The path to the target folder in which to save CSV files. The utility will create the folder if it doesn’t exist.
- The security key provided by Precision Bridge. Please note this changes daily.
In case the utility hits an API rate limit, it will pause and attempt to continue after the given amount of time (a retry_after header is returned which specifies the number of seconds to pause).
The full command then looks like the following:
>>> zendesktocsv_api.exe https://<domain>.zendesk.com/api/v2/ user@precisionbridge.net/token <api_token> <security_key>
Comments
0 comments
Please sign in to leave a comment.