Skip to content

HTTPAPI.md

Latest commit

 

History

History
67 lines (50 loc) · 2.59 KB

HTTPAPI.md

File metadata and controls

67 lines (50 loc) · 2.59 KB
Raw

Chargy Transparency HTTP API

The embedded HTTP API runs in the hardened Electron main process and forwards transparency records to the renderer for Chargy parsing and verification.

Since version 1.3.1 the Chargy transparency software comes with an optional HTTP API. The intention of the HTTP API is to simplify the interaction betweem Chargy and other third-party software on your own computer or within your (local) computer network.

Starting the HTTP API

The HTTP API can be started by adding the "--http" command line parameter when starting chargy. You will currently need to run the application in its normal mode. The CLI mode is currently not supported.

./run.sh --http

Chargy will start the HTTP API on localhost (IPv4 and IPv6) port 8080. If you want to attach it to another TCP/IP port then you can use the following command line parameter.

./run.sh --http=8081

If you want to listen on a specified IPv4 address you can use the following command line parameter values:

./run.sh --http=10.0.0.1:8081

If you want to listen on a specified IPv6 address (here IPv6 localhost) you can use the following command line parameter values:

./run.sh --http=[::1]:8081

If you want Chargy to listen on any IPv4 address you can use the following command line parameter values:

./run.sh --http=0.0.0.0:8081

If you want Chargy to listen on any IPv4 and IPv6 address you can use the following command line parameter values:

./run.sh --http=:8081

Verification of transparency records

If you want to use the Chargy HTTP API for validating charge transparency records you can use the following HTTP requests:

curl -v --data        "@documentation/chargeIT/chargeIT-Testdatensatz-01.chargy" http://127.0.0.1:8080/verify
"Valid signature"

curl -v --data-binary "@documentation/chargeIT/chargeIT-Testdatensatz-02.zip"    http://127.0.0.1:8080/verify
"Valid signature"

curl -v --data-binary "@documentation/chargeIT/chargeIT-Testdatensatz-01+02.zip" http://127.0.0.1:8080/verify
["Valid signature","Valid signature"]

Conversion of transparency records

If you want to validate Chargy or just like to convert your charge transparency records in a more user-friendly pure JSON format you can use the following HTTP requests:

curl -v --data        "@documentation/chargeIT/chargeIT-Testdatensatz-01.chargy" http://127.0.0.1:8080/convert
{ ... }

You can also retrieve a pretty-printed JSON via the following HTTP request:

curl -v --data-binary "@documentation/chargeIT/chargeIT-Testdatensatz-01+02.zip" http://127.0.0.1:8080/convert?pretty
{ ... }