https://github.com/nsat/spire-api-postman-collection

Postman collection for getting started with Spire APIs and services
https://github.com/nsat/spire-api-postman-collection

ais cubesat martime satellite space

Last synced: 6 months ago
JSON representation

Postman collection for getting started with Spire APIs and services

• Host: GitHub
• URL: https://github.com/nsat/spire-api-postman-collection
• Owner: nsat
• License: mit
• Created: 2017-07-21T00:22:49.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-03-25T23:12:20.000Z (about 6 years ago)
• Last Synced: 2025-03-17T18:16:08.807Z (about 1 year ago)
• Topics: ais, cubesat, martime, satellite, space
• Size: 333 KB
• Stars: 14
• Watchers: 7
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# 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](https://spire.com/contact/developer-portal/).

2. [Postman](https://www.getpostman.com) for Mac, Windows, or Chrome.

# Setup

3. Clone or [download](https://github.com/kjbrazil/spire-api-postman-collection/archive/master.zip) this repo to your local machine.

4. Open Postman.

5. In the top left corner click "Import".

![Import](https://github.com/kjbrazil/spire-api-postman-collection/blob/master/images/import.png?raw=true)

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

![Drop Files](https://github.com/kjbrazil/spire-api-postman-collection/blob/master/images/drop_files.png?raw=true)

![Select Files](https://github.com/kjbrazil/spire-api-postman-collection/blob/master/images/select.png?raw=true)

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".

![Manage Environements](https://github.com/kjbrazil/spire-api-postman-collection/blob/master/images/environments.png?raw=true)

9. Click "Spire".

![Select Environment](https://github.com/kjbrazil/spire-api-postman-collection/blob/master/images/manage_environments.png?raw=true)

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.

![Token](https://github.com/kjbrazil/spire-api-postman-collection/blob/master/images/token.png?raw=true)

12. Click "Update" and close the window.

13. Click the environment drop down again and select "Spire".

![Select Environment](https://github.com/kjbrazil/spire-api-postman-collection/blob/master/images/select_environment.png?raw=true)

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.

![First Request](https://github.com/kjbrazil/spire-api-postman-collection/blob/master/images/first_request.png?raw=true)

# Support

If you encounter any issues please [email Spire Customer Experience](mailto:cx@spire.com). Please also feel free to improve upon the collection and submit pull requests. :-)