server/

directory
v0.0.0-...-c477d60 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2019 License: GPL-3.0

README

Fin4 Server

This repo contains all files of the finance 4.0 server.

High level overview

The server currently has three main purposes

  • routing API requests from clients to the right destination
  • Business logic
    • Creating new fin4 tokens
    • Storing/ caching tokens in a mysql database
    • Handling user information
  • Communication with the blockchain
    • Deploying fin4 tokens to Ethereum (ganache/ rinkeby/ mainnet)
APIs

Communication with the server is done via http. The entry point for all http requests is the routes/routes.go code. All /wapi/ requests are forwarded to userhandlers/routing.go and tokenhandlers/routing.go.

The following methods currently exist

http Method URL Body Purpose
GET /api/status - Returns the status of the server.
POST /wapi/register "name":String,
"email":String,
"password":String,
"agreeToTerms":boolean,
"isFastSignup":boolean
Registers a user in the fin4 system.
POST /wapi/login "name":String,
"email":String,
"password":String,
Logs a user in. The returned session cookie needs to be used for all /wapi/... methods, except for the register method.
GET /wapi/session - Gets the current session.
GET /wapi/tokens - Fetches all fin4 tokens.

All /wapi/ requests need to provide the session cookie to the server, which was returned with the /wapi/login, in order to be correctly authenticated.

Documentation

For a detailed documentation of all functions, check out: https://godoc.org/github.com/FuturICT2/fin4-core/server/

Jump to

Keyboard shortcuts

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