...
ShipHawk has now included the release version number on the user interface, so you can easily see which version you are using. For example, from the ? icon on the top menu bar, you now have:
...
URL Subdomain Format
TMS URL Format
For TMS (Shipping), the customer-facing URL format will be as follows:
https://subdomain.tms.myshiphawk.com
Where subdomain is an identifier for the customer.
For example, if the customer is named Acme, the URL for their users to sign in could be:
https://acme.tms.myshiphawk.com
(NOTE: For customers that don’t have a subdomain assigned, we will generate a 6-letter identifier.)
WMS URL Format
Similarly, if a subdomain is used for WMS (Warehousing), the customer-facing URL format will be as follows:
https://subdomain.wms.myshiphawk.com
Where subdomain is an identifier for the customer.
For example, if the customer is named Acme, the URL for their users to sign in could be:
https://acme.wms.myshiphawk.com
(NOTE: For customers that don’t have a subdomain assigned, we will generate a 6-letter identifier.)
How This Change Will Impact End Users
Old Behavior: At present, customer users sign in to ShipHawk using a URL, such as: https://www.shiphawk.com/app/sign-in
This URL will continue to work for old (current/previous) customers.
New Behavior: Now, however, new customers should use the new login page, which is:
https://login.myshiphawk.com/
💻 This new login page is unified for ALL production environments: this means that dedicated customers can use https://login.myshiphawk.com/to login into their ShipHawk web portal.
New customers can also use their custom login page (with subdomain) that points specifically to their instances, such as:
https://subdomain.tms.myshiphawk.com/app/sign-in
For example, an employee at Acme can sign in to ShipHawk from either
https://login.myshiphawk.com/
or
https://acme.tms.myshiphawk.com/app/sign-in.
The ShipHawk Dashboard is then loaded, and the URL in their web browser will be:
https://acme.tms.shiphawk.com/app/dashboard
How This Change Will Impact API Endpoints
For a customer accessing ShipHawk from a ‘subdomain’ format URL, their API endpoints will also change accordingly based on the customer’s subdomain.
For example, instead of calling https://shiphawk.com/api, such as:
| Code Block |
|---|
curl --request GET 'https://shiphawk.com/api/v4/user' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' |
The full URL must include the subdomain. For a customer named Acme, for example, we have:
| Code Block |
|---|
curl --request GET 'https://acme.tms.myshiphawk.com/api/v4/user' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' |
The old API URLs will work for customers on current shared environments.
Dedicated customers and new customer accounts must use the new format only.
How Can a Customer Find Out the API Endpoint?
On the user interface:
Select ⚙️ (Settings) > Developer API.
Check the ‘URL hostname specific to your ShipHawk account’ field.
...
How This Will Affect Customer Firewalls
Customers should be sure to check their firewall settings to make sure the ShipHawk URLs in the subdomain format are not blocked.
Customers should include *.myshiphawk.com to their firewall configuration. If firewall configuration rules do not allow URLs with the asterisk wildcard character (*), customers will need to include the full URLs instead.
Performance Improvements
ShipHawk has completed further infrastructure enhancements to provide performance improvements, including:
...