What are REST API's?
With REST API’s we allow our users to integrate Cargosnap into their TMS, WMS or ERP systems. We even support connecting to Excel and BI tools, to create your own advanced dashboards.
The RESTful API gives you programmatic access to all Cargosnap functionality, for any given file. The API will allow you to pull all information as well as provide you a link to the images. The information is yours, so may be used to populate fields in an own database, download the information or create reports, to name a few applications.
API Developer Documentation
Click here: Cargosnap API documentation
⚠️ Note: Integrating with our API requires technical knowledge and development experience.
How to get there
In the top right corner, click on your company, then navigate to 'Company Settings' and select 'API Tokens':
Create your API token
1. Name your API to something easy to remember or refer to (e.g. the name of the system you will connect Cargosnap with).
2. Optional: There also is an option to add a Expiry date. This field may be used in situations where your company policy requires expiring tokens. Be sure to remember to re-create a new token before expiry!
3. Then click ‘Create’ - Done!
⚠️ IMPORTANT: do keep this token safe!
This is a powerful thing as it can do anything your administrators do in the platform. Make sure it does not get compromised, so don’t share it with wide audiences nor use email to share the token.
Collect the API token
You can collect the generated token by going back to the API token tab and clicking the “Copy to clipboard” button right next to the newly generated token. This will place it in your clipboard, so you can paste it into your configuration files.
Now it's time to start coding and build something cool!
Use the API to export in Excel
In below articles you will find more help to get this done!