Access Tokens
To authenticate yourself to ShipCaddie, you need to include an Access Token in each API call. If you don’t include an Token when making an API request, or if you use an incorrect or expired Token, then ShipCaddie will respond with an error “AccessToken is missing.”
Below is an example for an API request to validate an address. This example shows the Access Token at the start of the body in the request.
{ "accessToken": "YTcWPmtxXW6ENMvnbxxp..., "addressToValidate": { "address1": "2600 Executive Pkwy", "address2": "Suite 160", "city": "Lehi", "countryCode": "US", "stateOrProvidence": "UT", "postalCode": "84043" } }
To obtain an Access Token you’ll need to send a HTTP POST request to https://api.shipcaddie.com/api/v2.1/GetToken either using our API Reference Docs, or through a third party tool such as Postman and Curl.
Endpoints to get an Access Token
There are two different endpoints to get an Access Token:
Keep Your Credentials & Access Tokens Safe
Your Credentials and Access tokens give you full access to ShipCaddie’s functionality. With this in mind ShipCaddie recommends that you should treat them as you would treat a password or other sensitive credentials.
Below are some methods that can help keep your Credentials & Access Tokens secure:
Powered by BetterDocs