Getting Started

Prerequisites

1. Postman client
   
   

   NOTE: You can use either the Postman desktop client or web client (see Postman workspaces). However, this guide will focus on the user experience in the Postman desktop client.

2. An internet connection

Setup

1. Begin by downloading the ORC API specification.
2. Next, import the ORC API specification into Postman.

   NOTE: for instructions on how to import an API spec into Postman, see Importing an API.

3. In Postman you should now have a collection with the name Orbital Refuse Collector (ORC) API.

Usage

1. Verify that the collection was imported correctly by sending a request. For this example I will send the Get a list of satellites request, but you can test with any request.
2. Upon receiving a response, verify the following:
   a. The response status code was 200.
   b. You received back either a list of satellite objects in the response body or no response body (depending upon which request you tested).
   
   

NOTE: By default this collection uses a Wiremock server to simulate all endpoints. If you would like to change this behavior, you can modify the baseUrl value in the collection's variables.