Skip to content

Latest commit

 

History

History
169 lines (124 loc) · 6.82 KB

README.md

File metadata and controls

169 lines (124 loc) · 6.82 KB
Raw

The Enlighten Systems API Bash client

Overview

This is a Bash client script for accessing The Enlighten Systems API service.

The script uses cURL underneath for making all REST calls.

Usage

# Make sure the script has executable rights
$ chmod u+x 

# Print the list of operations available on the service
$ ./ -h

# Print the service description
$ ./ --about

# Print detailed information about specific operation
$ ./ <operationId> -h

# Make GET request
./ --host http://<hostname>:<port> --accept xml <operationId> <queryParam1>=<value1> <header_key1>:<header_value2>

# Make GET request using arbitrary curl options (must be passed before <operationId>) to an SSL service using username:password
 -k -sS --tlsv1.2 --host https://<hostname> -u <user>:<password> --accept xml <operationId> <queryParam1>=<value1> <header_key1>:<header_value2>

# Make POST request
$ echo '<body_content>' |  --host <hostname> --content-type json <operationId> -

# Make POST request with simple JSON content, e.g.:
# {
#   "key1": "value1",
#   "key2": "value2",
#   "key3": 23
# }
$ echo '<body_content>' |  --host <hostname> --content-type json <operationId> key1==value1 key2=value2 key3:=23 -

# Make POST request with form data
$  --host <hostname> <operationId> key1:=value1 key2:=value2 key3:=23

# Preview the cURL command without actually executing it
$  --host http://<hostname>:<port> --dry-run <operationid>

Docker image

You can easily create a Docker image containing a preconfigured environment for using the REST Bash client including working autocompletion and short welcome message with basic instructions, using the generated Dockerfile:

docker build -t my-rest-client .
docker run -it my-rest-client

By default you will be logged into a Zsh environment which has much more advanced auto completion, but you can switch to Bash, where basic autocompletion is also available.

Shell completion

Bash

The generated bash-completion script can be either directly loaded to the current Bash session using:

source .bash-completion

Alternatively, the script can be copied to the /etc/bash-completion.d (or on OSX with Homebrew to /usr/local/etc/bash-completion.d):

sudo cp .bash-completion /etc/bash-completion.d/

OS X

On OSX you might need to install bash-completion using Homebrew:

brew install bash-completion

and add the following to the ~/.bashrc:

if [ -f $(brew --prefix)/etc/bash_completion ]; then
  . $(brew --prefix)/etc/bash_completion
fi

Zsh

In Zsh, the generated _ Zsh completion file must be copied to one of the folders under $FPATH variable.

Documentation for API Endpoints

All URIs are relative to /api/v2

Class Method HTTP request Description
DefaultApi consumptionLifetime GET /systems/{system_id}/consumption_lifetime
DefaultApi consumptionStats GET /systems/{system_id}/consumption_stats
DefaultApi energyLifetime GET /systems/{system_id}/energy_lifetime
DefaultApi envoys GET /systems/{system_id}/envoys
DefaultApi inventory GET /systems/{system_id}/inventory
DefaultApi invertersSummaryByEnvoyOrSite GET /systems/inverters_summary_by_envoy_or_site
DefaultApi monthlyProduction GET /systems/{system_id}/monthly_production
DefaultApi productionMeterReadings GET /systems/{system_id}/production_meter_readings
DefaultApi rgmStats GET /systems/{system_id}/rgm_stats
DefaultApi searchSystemId GET /systems/search_system_id
DefaultApi stats GET /systems/{system_id}/stats
DefaultApi summary GET /systems/{system_id}/summary
DefaultApi systems GET /systems

Documentation For Models

Documentation For Authorization

ApiKey

  • Type: API key
  • API key parameter name: key
  • Location: URL query string