Supporting API

These are supporting APIs that do NOT use the JSON-RPC standard.

Remember to replace <NETWORK> with the appropriate network (mainnet, ropsten, or rinkeby).

Client information

Do not confuse the Client and ClientInfo objects (mentioned below), as they are distinct!

Get client information

Returns information about the client. This consists of the following:

  • Information about the client himself

  • The client's channel definition

  • The client's zone

URL: https://zone-manager.<NETWORK>.kchannels.io/ui/client_api/

REQUEST (HTTP GET)

  • Headers:

    • Authorization: Bearer YOUR_JWT_TOKEN

RESPONSE

  • Body:

    • ClientInfo object

Next steps

  1. Inspect the information and optionally display it in the UI.

Set client information

Set the client information using Form URL encoding (i.e. this isn't a JSON endpoint). Of course, the client_address cannot be changed, so post it but make sure it hasn't changed. Everything except client_address can be blank.

URL: https://zone-manager.<NETWORK>.kchannels.io/ui/client_api/

REQUEST (HTTP POST)

  • Headers:

    • Authorization: Bearer YOUR_JWT_TOKEN

    • Content-Type: application/x-www-form-urlencoded; charset=UTF-8

  • Body:

    • Form URL-encoded client information:

      • client_address

      • first_name

      • last_name

      • email

RESPONSE

The backend returns a Client object in the body.