Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/rubixchain/rubixplatform

A Combined Springboot Application
https://github.com/rubixchain/rubixplatform
Last synced: about 5 hours ago
JSON representation
A Combined Springboot Application
Host: GitHub
URL: https://github.com/rubixchain/rubixplatform
Owner: rubixchain
Created: 2020-11-06T10:49:23.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2023-01-13T12:08:15.000Z (almost 2 years ago)
Last Synced: 2023-06-14T20:08:53.199Z (over 1 year ago)
Language: Java
Size: 9.98 MB
Stars: 1
Watchers: 1
Forks: 2
Open Issues: 5
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # Rubix API Calls

## DID Creation

Creates a unique Decentralized IDentity 

> $ curl --location --request POST 'http://localhost:1898/create' --form 'image=@<"image path"

>' --form 'data={ "data": "9876543333,[email protected]"}'

***Request Type***:    POST

***Port***:     1898

***Input***:     data(String) and image(Multipart File)

***Returns***: DID (String)

## Initial Setup

Does the initial setup of IPFS and syncing the network nodes

*Make sure to make this call before any other following calls*

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/setup

***Request Type***:    GET

***Port***:     1898

***Input***:     nill

***Returns***: nill

## Transfer Tokens

Transfers token(s) from one wallet address to another 

> $ curl --header "Content-Type: application/json" --request POST http://localhost:1898/initiateTransaction --data '{ "receiver": "445f59c3d71c6769124470cf4b82ca0b9b1626aec4f14f50a8f1e6a13e1fc70d", "tokenCount":1, "comment":"transaction comments"}' 

***Request Type***:    POST

***Port***:     1898

***Input***:     receiver (String), tokenCount (Integer), comment (String)

***Returns***: Transaction ID (String), Success / Failure (Boolean), DID (String)

## Account Information

Retrieves the user account details 

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/getAccountInfo

***Request Type***:    GET

***Port***:     1898

***Input***:  nill

***Returns***: DID (String), WalletID (String), TransactionAsSender (Integer), TransactionAsReceiver (Integer), Balance (Integer)

## Account Balance

Check the balance in user's wallet

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/getBalance

***Request Type***:    GET

***Port***:     1898

***Input***:  nill

***Returns***: Account Balance(Integer)

## Get Transaction details with Transaction ID

Details of a particular transaction like Quorum involved, token transferred, receiver details, time and more

> $ curl --header "Content-Type: application/json" --request POST  http://localhost:1898/getTxnDetails --data '{"transactionID": "82A03ABB70495A2241D7FD51079A635040A145E4C701B2C1B0C2DC92CB79AFC A"}'

***Request Type***:    POST

***Port***:     1898

***Input***:    transactionID (String)

***Returns***:  senderDID(String), role(String), totalTime(Integer), tokens(ArrayList), comment(String), txn(String), receiverDID(String), Date(Date)

## Get Transaction details with Date

Retrieves the details of all the transactions committed during the specified period

> $ curl --header "Content-Type: application/json" --request POST http://localhost:1898/getTxnByDate --data '{"eDate":"2020-04-21", "sDate":"2020-04-02"}' 

 

 ***Request Type***:    POST

***Port***:     1898

***Input***:  sDate (String),  eDate (String)

***Returns***: senderDID(String), role(String), totalTime(Integer), tokens(ArrayList), comment(String), txn(String), receiverDID(String), Date(Date)

## Get Transaction details with Comment

Retrieves the details of all the transactions committed with the specified comment

> $ curl --header "Content-Type: application/json" --request POST http://localhost:1898/getTxnByComment

 --data '{"comment":"10,000Rs"}' 

 

 ***Request Type***:    POST

***Port***:     1898

***Input***:  comment (String)

***Returns***: senderDID(String), role(String), totalTime(Integer), tokens(ArrayList), comment(String), txn(String), receiverDID(String), Date(Date)

## Get Transaction details with Count

Retrieves the last specified count of transactions committed 

> $ curl --header "Content-Type: application/json" --request POST http://localhost:1898/getTxnByCount

 --data '{"count" : 3}' 

 

 ***Request Type***:    POST

***Port***:     1898

***Input***:  count (Integer)

***Returns***: senderDID(String), role(String), totalTime(Integer), tokens(ArrayList), comment(String), txn(String), receiverDID(String), Date(Date)

## Get Transaction details with User's DID

Retrieves all the transactions made with the input DID

> $ curl --header "Content-Type: application/json" --request POST http://localhost:1898/getTxnByDID

 --data '{"did" : "QmdkrLpyoGFrhsbeuZrXpcvr2QRsLuQnrbXVfJTe1yXqzy"}' 

 

 ***Request Type***:    POST

***Port***:     1898

***Input***:  did (String)

***Returns***: List of all transactions and its details made with the did

## View Proof Chains

Views proofchain of the input token.

>$ curl --header "Content-Type: application/json" --request POST http://localhost:1898/viewProofs --data '{"token": "Qma1dRiJYdHHx4zCFxKz8LEoNERwoqXYzSHFePkhhewbjE"}'

***Request Type***:    POST

***Port***:     1898

***Input***:   token(String)

***Returns***: ProofChain (String)

## List of Tokens

Lists out all the tokens available in the user's wallet

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/viewTokens

***Request Type***:    GET

***Port***:     1898

***Input***:   nill

***Returns***: List of Tokens (JSONObject)

## List of Peers Online

Lists all your contacts currently available online

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/getOnlinePeers

***Request Type***:    GET

***Port***:     1898

***Input***:   nill

***Returns***: List of objects: did(String), online/offline

## View Contacts 

Lists all your contacts

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/getContactsList

***Request Type***:    GET

***Port***:     1898

***Input***:   nill

***Returns***: List of DIDs

## Details for Dashboard

Lists all required details of user's wallet

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/getDashboard

***Request Type***:    GET

***Port***:     1898

***Input***:   nill

***Returns***: totalTxns(Integer), WalletID(String), balance(Integer), , receiverTxns(Integer), senderTxns(Integer), contactsCount(Integer), onlinePeers(Integer), transactionsPerDay(List), did(String)

## Close Streams

To close all the streams open

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/p2pClose

***Request Type***:    GET

***Port***:     1898

***Input***:   nill

***Returns***: nill

## Synchronise Network Nodes

To synchronize the DIDs of the systems, so that the node will have an updated list of all the DIDs in the network.

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/sync

***Request Type***:    GET

***Port***:     1898

***Input***:   nill

***Returns***: nill

## Shutdown

Closes all application processes and exits 

>$ curl --header "Content-Type: application/json" --request GET http://localhost:1898/shutdown

***Request Type***:    GET

***Port***:     1898

***Input***:   nill

***Returns***: nill