Objectives - PackageHub v3
Log into PackageHub v3 Portal, Select Signup Option, Retrieve iFrame HTML
*Note: For integrating a v2 signup page, click here.
Logging into Partner View of the PackageHub v3 Portal
Go the PackageHub Shipper Portal
If you are testing and using the Sandbox environment, the Sandbox PackageHub Shipper Portal is located here.
Select Customers in Left Nav
Expand Customers Accordion
Normal and Quick Signup Options
Normal Signup: Use this flow for customers signing up directly through the PackageHub portal.
Customers will be able to manage payment info and KEY SECRET within the PackageHub portal.
Quick Signup: Use this flow for customers signing up for a PackageHub account in 3rd party applications.
Customers may provide payment info, and once an account is created they will immediately get their KEY SECRET right after signup.
Retrieve iFrame HTML
Select HTML in the tab
Copy the iFrame HTML
Objectives - PackageHub v2
Generate One-time Use Token, Create Signup Page, and use an Additional Signup Option
Generate One-time Use Token
Production: https://api.packagehub.com/api/v2/accounts/GenerateOnboardToken
Sandbox: https://sandbox.packagehub.com/api/v2/accounts/GenerateOnboardToken
Header: Use your PackageHub ApiKey
Body: For the ClientName field, use the Partner Name (User) we have issued to you
Example request:
curl --location--request POST 'https://api.packagehub.com/api/v2/accounts/GenerateOnboardToken' \
--header 'Content-Type: application/json' \
--header 'APIKey: <ApiKey>' \
--data-raw '{
"ClientName":"<PartnerName>"
}
Example response:
{
"OneTimeToken": "b5a19fa7-6635-4608-92a1-7b2c611d3ce5",
"TimeInMs": 9.0
}
Create Signup Page
Once the OneTimeToken is created, in the URL include ?token={OneTimeToken}
Additional Signup Options
Require Payment Method Option
The 3 options are Credit Card, ACH or None. To enforce Credit Card or ACH selection, in the URL, include &requirePaymentMethod=true
Example URL
CSS Option
For select partners, we will allow customization of the CSS file. To enable it, in the URL include &customCSS={ClientName}
Example URL
Hide Login Button on Step 3 Option
On step 3 of the signup process, the Login button that goes to the PackageHub v2 portal &removeLoginButton=true
Example URL