REST API - mangei/onion-routing GitHub Wiki

Quote Service

Quote

/quote - GET - returns a new quote message

{
    "quote": "Lorem Ipsum"
}

Chain Node

Request

/request - POST - processes a request see Protocol

Directory Node

Register

/register - POST - registers a new node

Request:

{
    "public_key": "",
    "ip": "",
    "port": ""
}

Response:

{
    "secret": "" 
}

secret is for heartbeat to identify the chain node.

Heartbeat

/heartbeat - PUT - processes a heartbeat for a chain node

Request:

{
    "secret": ""
}

Response: HTTP codes

Chain

/chain - GET - gets a new chain for an Originator

Request: empty

Response:

{
    "chain_nodes": [
        {
        	"ip": "",
        	"port": "",
        	"public_key": ""
        },
        {
        	"ip": "",
        	"port": "",
        	"public_key": ""
        },
        {
        	"ip": "",
        	"port": "",
        	"public_key": ""
        }
    ]
}

nodes

/nodes - GET - get information about all available nodes

Request: empty

Response:

{
    "nodes": [
        {
        	"ip": "",
        	"port": "",
        	"public_key": "",
        	"register_date": "",
        	"last_heartbeat": ""
        },
        ...
    ]
}