API documentation

• API documentation
  • Initialization
  • Environmental functions
    • Show available calls
    • Get credentials
    • Store credentials
    • Get versions
  • Locations
    • Get locations

Initialization

First, we set some variables.

export GRID_API_HOST="http://localhost:9880"
export GRID_API_KEY="1|testKeyForDevelopmentOnly"

Environmental functions

Show available calls

curl -i \
    -H 'accept: application/json' \
    -X 'GET' "${GRID_API_HOST}/api/"

Get credentials

curl -i \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${GRID_API_KEY}" \
    -X 'GET' "${GRID_API_HOST}/api/credentials"

Store credentials

curl -i \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${GRID_API_KEY}" \
    -H 'Content-Type: application/json' \
    -X 'PUT' "${GRID_API_HOST}/api/credentials" \
    -d '{"key":"value"}'

Get versions

curl -i \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${GRID_API_KEY}" \
    -X 'GET' "${GRID_API_HOST}/api/versions"

Locations

Get locations

curl -i \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${GRID_API_KEY}" \
    -X 'GET' "${GRID_API_HOST}/api/locations"