If you have a Business or Enterprise account with Crux Systems, you already have access to our API integration feature. The way you set up your specific connection may vary, but at the basic level you'll need to do two things:
- generate an API key to submit your containers via the API and updates through Webhooks
- configure webhook notifications to receive updates about your container status
Submitting containers via the API
To submit containers to your Crux Systems dashboard via the API, you will need to generate an API key on the Integration section in My account. You need to be an account owner to access the API key.
Once you have generated that key, you're ready to submit containers to your dashboard using the API. For every API submission, you will receive a response from Crux Systems, which will tell you either:
- we received the request (this is the most common message)
- the container was invalid (this means the system did not recognize the value submitted as a valid container number)
- unable to add container (this will happen if you've already reached your container limit for the current billing period. If you need to upgrade, you can do so from your dashboard)
The details of the format of the information you need to submit is in our API Documentation
To receive continuous updates about the status of your containers, set up your webhook.
Getting updates via a webhook
When you set up a webhook for updates, you'll automatically receive updates when the status of your container changes for the containers you're tracking.
If you need help establishing a webhook, please consult your IT department and request a web server that can accept POSTS to URL. They should be able to provide the URL for the web endpoint, and may be in an already set up server in your company.
The information that the Webhook notification contains is described in our API Documentation
Webhook Notifications can be transmitted in plain text (through an http endpoint) or encrypted if your web server uses https. In this latter case, the notification will also send the same API Key that you generated for the API as an extra means of authentication.
Testing and maintaining your API integrations
Once you've set up your API key and webhook, you're ready to receive information from our system. To test the APIs and webhook, see the the instructions available in this article. See our complete API documentation for more detailed information.
If your team has questions, please let us know how we can help you complete your integration by emailing email@example.com.