Data Exports access controls which users can retrieve your account's Recurring Data Exports files through the ShipHero Public API. Grant access only to users who need to download or analyze this data.
Before You Begin
- Administrator access: You need administrator access to change user permissions.
- User type confirmed: Confirm whether the person uses a regular ShipHero user or a third-party Developer User.
Important
Recurring Data Exports may contain sensitive business and personal data. Review the user, account, and data access before granting permission.
For an overview of Recurring Data Exports, including the schedule and data modules, see Overview: Recurring Data Exports in ShipHero. For the retrieval steps, see How to Access Recurring Data Exports in ShipHero.
Table of Contents
- Give a Regular User Recurring Data Exports Access
- Give a Developer User Recurring Data Exports Access
- Troubleshoot Recurring Data Exports Permissions
Give a Regular User Recurring Data Exports Access
An administrator grants Recurring Data Exports access to a regular ShipHero user from the same API Access section used to grant Public API access. Select Enable API Access first, then Enable Data Exports Access, review the warning, and save. Non-admin users cannot change these permissions.
To turn on API access and Data Exports access for a user, see How to Give a ShipHero User API Access.
Give a Developer User Recurring Data Exports Access
Use the Developer Users settings when an external integration uses a token-based third-party Developer User.
- Go to My Account > Developer Users.
- To create a developer user, select Add Third-Party Developer. To update an existing developer user, select Edit.
- Complete or review the developer user's details.
- Select Enable Data Exports.
- Review the warning, then select OK.
- Select Add Developer or Update Developer.
Developer Users use API tokens and refresh tokens instead of signing in to ShipHero with the regular application login. See How to Obtain API Access and Refresh Tokens.
Troubleshoot Recurring Data Exports Permissions
When a user still cannot retrieve Recurring Data Exports after you grant access, see the troubleshooting section of How to Access Recurring Data Exports in ShipHero. It covers permission errors, API access errors, Developer User problems, and missing data.