Spire Sense API Postman Collection

A set of example HTTP requests for the Spire Sense APIs using the Postman API client. These include the following endpoints:

• Vessels
• Messages
• Predict AI

Requirements

In order to utilize this repo you will need two things:

1. A Spire API access token.
2. Postman for Mac, Windows, or Chrome.

Setup

3. Clone or download this repo to your local machine.
4. Open Postman.
5. In the top left corner click "Import".

6. Drag or find both the Spire_API.postman_collection.json & Spire.postman_environment.json files and click open.

7. Both the collection and the environment variables will be imported to Postman.
8. In the top right corner, click the gear icon and select "Manage Environments".

9. Click "Spire".

10. Locate the access token sent to you by the Spire Customer Experience team.
11. Navigate back to Postman and replace your-api-token with your actual credentials.

12. Click "Update" and close the window.
13. Click the environment drop down again and select "Spire".

14. You are now ready to start making API calls!
15. Try querying all Spire vessels by clicking the 01_Vessels folder > "List All Vessels" > Send.

Support

If you encounter any issues please email Spire Customer Experience. Please also feel free to improve upon the collection and submit pull requests. :-)