Last Updated December 23, 2021

Before getting started

• A valid ProtoPie Connect server needs to be up and running to use the Connect API
  • On ProtoPie Connect Desktop and ProtoPie Connect Embedded, the application needs to be running.
• As of now, there is no authentication required to make requests using the API

Get Pie Information on ProtoPie Connect

• The get pie information API retrieves information about pies that have been loaded to ProtoPie Connect.
• The response is of JSON format

Request

• URL

  GET /pies HTTP/1.1
  Host: {CONNECT_SERVER_IP}:9981
  

• Header

  • Not Required

• Parameters

  • None

Response

• Responds with List<pie_info> in JSON format.

  pie_info

Samples

• Request

  • When requesting from the same machine as ProtoPie Connect

    curl -X GET [<http://localhost:9981/pies>](<http://localhost:9981/pies>) 
    

  • When requesting from a remote machine connected to the same network as ProtoPie Connect. CONNECT_SERVER_URL is the URL shown in the ProtoPie Connect console (e.g. 192.168.100.111:9981)

    curl -X GET http://{CONNECT_SERVER_URL}:9981/pies
    
    curl -X GET <http://192.168.100.111:9981/pies>
    

  • One can also use the browser's address bar to see the results in the web browser.

    

• Response

  [
  	{
  		"pieid":"13",
  		"name":"wearable-smartwatch-crossfit",
  		"filepath":"/Users/protopie/pies/wearable-smartwatch-crossfit.pie",
  		"createdAt":"2021-10-14T02:49:35.917Z"
  		"webPlayerConnected":false,
  		"ipPlayerConnected":true,
  		"usbPlayerConnected":false,
  		"webPlayerURL":"<http://192.168.100.111:9981/pie?pieid=13&name=wearable-smartwatch-crossfit>"
  	},
  	...
  ]