You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close

Postman - HTTP API Testing and Troubleshooting Tool


Overview

Postman is a program that allows the user to interact with HTTP APIs. When used with Just Add Power, it can send POST and GET requests and display the responses.

It is a useful tool when troubleshooting or testing how a control system interacts with Just Add Power's justOS RESTful API.

Full information on justOS API is available at https://justaddpower.docs.stoplight.io


Download

Postman can be downloaded from the main Postman website at www.getpostman.com.


Firmware

justOS B1.2.1 or later required


Using Postman

When first opening Postman, the Launchpad screen will appear. Select Create a request to open a new tab.

Navigate to the Untitled Request tab. There are 3 key parts to this window:

  1. GET/POST dropdown - set the type of request
  2. Request URL bar - enter the IP address and endpoint URI
  3. Send button - execute the request to the endpoint URI


GET Commands

To retrieve information from the Just Add Power device, use the GET function. Full list of GET functions is available at https://justaddpower.docs.stoplight.io. Example below returns all Settings on a device.


POST Commands

To execute live commands or change boot-up settings on a Just Add Power device, use the POST function and execute the command in the Body in JSON format. Full list of POST functions is available at https://justaddpower.docs.stoplight.io.

  1. Enter the IP address of the Just Add Power device followed by the endpoint URI
  2. Go to the tab below the address bar and select the Body section
  3. Select the radio button for raw and JSON from the dropdown on the right side.
  4. Enter the command in the correct format in the body below.
  5. Click Send to execute.

The example below shows how to set a Receiver to show the top-left corner of a 2x2 video wall by sending [2,2,1,1]

  • 347
  • 20-Nov-2019
  • 1354 Views