Fetch and Load Juicebox Apps API

Warning

This help isn’t complete. It may even look terrible. If you want to work on it, see How to Contribute. You can also ask for help in the Juice Slack #documentation channel.

The Fetch and Load endpoints provide a way to fetch juicebox apps for initial install or update as well as a way load juicebox apps. This must be done by a staff account.

Fetch a Juicebox App

POST /api/v1/app/fetch/(string: app_slug)/

Fetch a Juicebox App

Example Request:

POST /api/v1/app/fetch/vcdashboard/
Accept: application/json
Authorization: Token 7297b3ebb0e7f7baf5f54d39908dda99f5ea8665

{
  "app_version": "latest"
}

Example Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

{
    "message": "Loaded vcdashboard version latest"
}
Request JSON Object:
 
  • app_version (string) – An optional qualifier used to load a specific version.
Response JSON Object:
 
  • message (string) – the result message
Request Headers:
 
  • Accept – the response content type depends on Accept header
  • Authorization – contains the token to be used for authentication
Response Headers:
 
Status Codes:

Load a Juicebox App

POST /api/v1/app/load/(string: app_slug)/

Load a Juicebox App

Example Request:

POST /api/v1/app/load/vcdashboard/
Accept: application/json
Authorization: Token 7297b3ebb0e7f7baf5f54d39908dda99f5ea8665

Example Response:

HTTP/1.1 204 OK
Vary: Accept
Content-Type: text/javascript
Request Headers:
 
  • Accept – the response content type depends on Accept header
  • Authorization – contains the token to be used for authentication
Response Headers:
 
Status Codes: