Skip to content

Files

Latest commit

mdeverill-spiremdeverill-spire
Add files via upload
Jan 19, 2022
78836f7 · Jan 19, 2022

History

History
This branch is 8 commits behind spireglobal/maritime:main.

spire-graphql-postman-collection

README.md

Spire Sense API Postman Collection

A set of example HTTP requests for the GraphQL-based Spire Vessels V2 API using the Postman API client.

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

  1. Clone this repo to your local machine.
  2. Open Postman.
  3. In the top left corner click "Import".

Import

  1. Drag or find both the Spire_GraphQL_Postman_Collection.postman_collection.json & Spire.postman_environment.json files and click open.

Drop Files

Select Files

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

Manage Environements

  1. Click "Spire".

Select Environment

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

Token

  1. Click "Update" and close the window.
  2. Click the environment drop down again and select "Spire".

Select Environment

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

First Request

Support

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