Skip to content

cavallo-dev/documentasy_cavallo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

documentasy_cavallo

Introduction

Introduction

Welcome to Cavallocoin.io API documentation! Cavallocoin is a simple,accessed over HTTP or HTTPS from the cavallocoin.io domain.

Integration

How to make integrate :

  1. Develop (make) modul interface on your system (member) that contains of sender functions transaction request to environment development system Cavallocoin.io based on spesification.

Development

We dedicate this environmental development to ease you doing integration modul your H2H system to Cavallocoin.io.

In this phase, please make an interface modul on your system (member) who has to send the request to URL API in Cavallocoin.io which appropriates with the spesification.

Target URL API Development

Format Target URL
JSON POST https://www.cavallocoin.io/api

API Referention

Please use message format which is convenient for your (member), there is some format that is available, such as : JSON.

You can check your current limits and usage via a POST on the following endpoint, outside of our normal coin/chain pattern:

Generally, in the option JSON format , every transaction request is sent through HTTPS protocol HTTPS to target URL API cavallocoin.io with condition:

  1. header Content-Type: application/json to JSON format.
  2. contains to contents request according to API cavallocoin.io spesification.
  3. And set Authorization: Bearer $api_token.
      <h2 id="make-transaction">Make Transaction</h2>

Making the latest transaction.
first you need to provide the input password, wallet, and amount.

Make Transaction Request

curl https://www.cavallocoin.io/api/transac
{
  "password": "YOUR_PASSWORD",
  "address": "MEMBER_ADDRESS",
  "amount": "MEMBER_AMOUNT",
}

Request Parameters

          </tbody></table>

Make Transaction Response

{
  "success": "true",
  "data":{
  "message": "Your transaction has ben success",
  "balance": "0.000000000",
  "block":{
  "hash": "e1ec83047d0beb49ba9e2f480f206386869e81dbf461ee1c15bc7592e003453a",
  "sender_id": "5a16c59a402c5a04a84ea3be",
  "receiver_id": "5aa8b74e402c5a4ebf2cf2a2",
  "data": "5fd85baed63db0722d44d7063bbc154daedc38ee304e22cc23fe3bacffe9ca6a",
  "value": "1.0000000000",
  "created_at": "2018-05-01 11:20:17",
  "_id": "5ae83151402c5a17653f06e3"
}}
}
      <h2 id="create-wallet">Create Wallet</h2>

Create Wallet Request

curl https://www.cavallocoin.io/api/new
{ "password": "YOUR_PASSWORD" }

Parameters Request

Parameters Value Description
password YOUR_PASSWORD your password
address MEMBER_ADDRESS member address.
amount MEMBER_AMOUNT amount member.
Parameters Value Description
password YOUR_PASSWORD your password

Create Wallet Response

curl https://www.cavallocoin.io/api/new
{
"success": "true",
"data":{
"message": "Account created", "detail":{
"wallet":"SYrOykTM6LEL3jhCxQEXrqXMO8lhVMicoYu9owGp46YLn8PaGVNOTB5ekz54pxPGk6VAgkX9cGiYR", "balance":"0", "secret_key":"645716fb88007616783d818c9b2a7d616fc97154932757357e3e79a70363c5ee673ffce2d4453fd3de8e817eb7aa86d9b79339e850aa35c26e387c427e183485", "id":"5ae825d8402c5a230812ea73", "token":"010fa85d20fa4e586254c9a386a57a9f2ce1937ae904d22f7865aa5f09aea7626de2b22897ada7f5e4843ecdee0135281733807686dd8b3bad7efeae4e3cabd3"} } }
      <h2 id="check-ballance">Check Balance</h2>

Check Balance Request

curl https://www.cavallocoin.io/api/balance
{
  "password": "YOUR_PASSWORD",
  "key": "YOUR_SECRET_KEY"
}

Parameters Request

          </tbody></table>

Check Balance Response

curl https://www.cavallocoin.io/api/new
{
"success": "true",
"data":{
"message": "Account created", "detail":{
"wallet":"SYrOykTM6LEL3jhCxQEXrqXMO8lhVMicoYu9owGp46YLn8PaGVNOTB5ekz54pxPGk6VAgkX9cGiYR", "balance":"0", "secret_key":"645716fb88007616783d818c9b2a7d616fc97154932757357e3e79a70363c5ee673ffce2d4453fd3de8e817eb7aa86d9b79339e850aa35c26e387c427e183485", "id":"5ae825d8402c5a230812ea73", "token":"010fa85d20fa4e586254c9a386a57a9f2ce1937ae904d22f7865aa5f09aea7626de2b22897ada7f5e4843ecdee0135281733807686dd8b3bad7efeae4e3cabd3"} } }

Response Code

Response Code is a respond code that is given by cavallocoin.io system as status from every transaction request which is sent by member system (CA).

Based on the outline, the following are response code less:

Parameters Value Description
password YOUR_PASSWORD your password
key SECRET_KEY your key
Status Code Description
200 Your transaction has been success
200 Account created
500 Unauthenticated
500 The given data was invalid.
200 Something wrong.
405 method not allowed.
404 page not found.
The list of code response can change along with the increase of product scope which is supported by cavallocoin.co.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages