client

command

v0.0.0-...-742d8af Latest Latest Go to latest Published: Jan 12, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

This tool allows issuing requests against the ChargePoint API from the command line:

> go build ./cmd/client

> cat credentials.json
{
  "APIKey": "<SNIP>",
  "APIPassword": "<SNIP>"
}

> ./client \
    --credentials="credentials.json" \
    --http_log="http_log.jsonl" \
    --url="<API_URL>" \
    --method="GetCPNInstances" \
    --request="{}" \
    | jq
2020/05/11 22:31:20 Using request: &schema.GetCPNInstancesRequest{XMLName:xml.Name{Space:"", Local:""}}
{
  "XMLName": {
    "Space": "ns1",
    "Local": "getCPNInstancesResponse"
  },
  "ChargePointNetworks": [
    {
      "ChargePointNetworkID": "1",
      "ChargePointNetworkName": "NA",
      "ChargePointNetworkDescription": "ChargePoint Operations"
    },
    {
      "ChargePointNetworkID": "2",
      "ChargePointNetworkName": "EU",
      "ChargePointNetworkDescription": "ChargePoint Europe"
    },
    {
      "ChargePointNetworkID": "3",
      "ChargePointNetworkName": "AU",
      "ChargePointNetworkDescription": "ChargePoint Australia"
    },
    {
      "ChargePointNetworkID": "4",
      "ChargePointNetworkName": "CA",
      "ChargePointNetworkDescription": "ChargePoint Canada"
    }
  ]
}

The HTTP log is written in JSONL format (details are in soap.go), and so can also be inspected with jq:

> jq '(.RequestBody, .ResponseBody) |= @base64d' < http_log.jsonl
{
  "RequestTimestamp": "2020-05-11T22:31:20.736844-07:00",
  "RequestMethod": "POST",
  "RequestURL": "https://webservices.chargepoint.com/webservices/chargepoint/services/5.0",
  "RequestHeaders": {
    "Content-Type": [
      "text/xml; charset=utf-8"
    ]
  },
  "RequestBody": "<Envelope xmlns=\"http://schemas.xmlsoap.org/soap/envelope/\"><Header><Security xmlns=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\" xmlns:envelope=\"http://schemas.xmlsoap.org/soap/envelope/\" envelope:mustUnderstand=\"1\"><UsernameToken><Username>{{SNIP}}</Username><Password Type=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText\">{{SNIP}}</Password></UsernameToken></Security></Header><Body><getCPNInstances xmlns=\"urn:dictionary:com.chargepoint.webservices\"></getCPNInstances></Body></Envelope>",
  "ResponseTimestamp": "2020-05-11T22:31:21.140106-07:00",
  "ResponseStatusCode": 200,
  "ResponseBody": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns1=\"urn:dictionary:com.chargepoint.webservices\"><SOAP-ENV:Body><ns1:getCPNInstancesResponse><CPN><cpnID>1</cpnID><cpnName>NA</cpnName><cpnDescription>ChargePoint Operations</cpnDescription></CPN><CPN><cpnID>2</cpnID><cpnName>EU</cpnName><cpnDescription>ChargePoint Europe</cpnDescription></CPN><CPN><cpnID>3</cpnID><cpnName>AU</cpnName><cpnDescription>ChargePoint Australia</cpnDescription></CPN><CPN><cpnID>4</cpnID><cpnName>CA</cpnName><cpnDescription>ChargePoint Canada</cpnDescription></CPN></ns1:getCPNInstancesResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>\n"
}

xmllint can be used to pretty-print the XML:

$ jq '(.RequestBody, .ResponseBody) |= @base64d | .ResponseBody' --raw-output \
    < http_log.jsonl \
    | xmllint --format -
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:dictionary:com.chargepoint.webservices">
  <SOAP-ENV:Body>
    <ns1:getCPNInstancesResponse>
      <CPN>
        <cpnID>1</cpnID>
        <cpnName>NA</cpnName>
        <cpnDescription>ChargePoint Operations</cpnDescription>
      </CPN>
      <CPN>
        <cpnID>2</cpnID>
        <cpnName>EU</cpnName>
        <cpnDescription>ChargePoint Europe</cpnDescription>
      </CPN>
      <CPN>
        <cpnID>3</cpnID>
        <cpnName>AU</cpnName>
        <cpnDescription>ChargePoint Australia</cpnDescription>
      </CPN>
      <CPN>
        <cpnID>4</cpnID>
        <cpnName>CA</cpnName>
        <cpnDescription>ChargePoint Canada</cpnDescription>
      </CPN>
    </ns1:getCPNInstancesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Documentation ¶

Overview ¶

client is a reflection-based command-line interface to the ChargePoint API client library. For example:

$ ./client \
      --credentials="credentials.json" \
      --http_log="http_log.jsonl" \
      --url="http://example.com/chargepoint/api" \
      --method="GetStations" \
      --request='{"SearchQuery": {"StationGroupID": "1:23456"}}'

This tool is intended to simply be illustrative and help with exploring the ChargePoint API.

Source Files ¶

View all Source files

main.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL