Code Monkey home page Code Monkey logo

spire-api-postman-collection's Introduction

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

  1. Clone or download 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_API.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. :-)

spire-api-postman-collection's People

Contributors

kjbrazil avatar max-at-spire avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.