To use ShipHero's Public API, you must have a GraphQL API Access and Refresh Token. Begin by creating a Third-Party Developer user (or dev user) in the ShipHero account where you need API access. Just like all other users, the email for the developer user must be unique, as the same email cannot be used across multiple users in the platform.
How to Add a Third Party Developer
Adding a third-party developer to your ShipHero account is easy; just follow the steps below.
- Go to the My Account > Developer Users page.
- Click on Add a 3rd Party Developer on the top right side of the page.
- Enter the Developer Details (First Name, Last Name, Email), then click Add Developer.
- Once the user has been created, the API Access Token and Refresh Token will appear. Be sure to copy the Access Code so you can send it to your developer as it will only be displayed once. If you need to create a new Access Token you can do using the Refresh Token.
Important Token and Account Considerations
- The Refresh Token remains active and static as long as the associated account is active.
- The Access Token expires after 28 days and requires the Refresh Token to regenerate.
- If an account becomes canceled, suspended, or inactive, generated tokens will not function, even if the token generation process appears successful.
- To minimize account-related complications, create a dedicated developer user for each unique 3rd party integration.