The authentication token is a unique, randomly generated passkey that verifies that the API request is valid. Without this token, the API will not be able to automatically log in to the system. The Authentication Token can be retrieved from either your staging environment or from your production environment. Visit your company specific url in either your staging or production environment.
Your staging environment url for shipper configuration is structured like the following:
https://<your company name>.cloudlogistics-staging.com/configure/shippers
Your production environment url for shipper configuration is structured like the following:
https://<your company name>.gocloudlogistics/configure/shippers
Select a shipper from the list by clicking anywhere on the row of that shipper.
Once redirected to the shipper’s page, click the Edit Shipper button.
You will be routed to the page where the authentication token can be accessed. The authentication token will appear at the top of the right column. The field will be greyed out meaning that it can’t be changed. The Authentication Token is required for each request made to the system. The Authentication Token can be processed in two ways:
- URL parameter (auth_token
- In the SOAP HEADER: X-AUTH-TOKEN
If it fails, you will receive an error message. Please note, if one of your payments has bad data, the entire transaction is invalid. Invoices not in the state of 'Accepted' or 'Paid' will cause the transaction to be invalid.
Not Allowed - Bad data in the XML or current delivery state does not allow an update
The following command is an example of how to use curl.
curl -H ‘Content-Type:application/xml’ -H ‘Accept:application/xml’ -k -X POST -d @import.xml https://<url>.<cloudlogistics-staging/gocloudlogistics>.com/<endpoint from above>?auth_token=...
Installing Curl on Windows
Select Type of Package: curl executable
Select Operating System: Windows / Win32 or Win64
Select for What Flavour: Generic
Select which Win32 Version (only if you selected Windows / Win32 in step 2): Unspecified
If you chose Windows / Win32 you should end up here, a page that links to http://www.paehl.com/open_source/?CURL_x.y.z (x.y.z will change as newer versions of curl are released). There you can click the first link ("Download WITHOUT SSL") or second link ("Download WITH SUPPORT SSL") for a zip file with curl.exe.
Windows curl example (Based on “WITH SUPPORT SSL” version):
curl -H “Content-Type:application/xml” -H “Accept:application/xml” -k -X POST --data “@import.xml” https://<url>.<cloudlogistics-staging/gocloudlogistics>.com/<endpoint from above>?auth_token=...