502647092
/
tera
1
0
Fork 0
Code Releases Activity
tera/Doc/Eng/API2.md

4.8 KiB
Raw Blame History

API v2 (for exchanges)

The API is designed to make it easier to write third-party applications. Server-side cryptography and POW operations are performed. Therefore, it is not recommended for public access, because it is not protected from DDOS attacks. Use it if applications such as the exchange server are on the same private network.

This API is available if server is running http and hosting included constant USE_HARD_API_V2.

Set the constants:

  • HTTP_HOSTING_PORT:80
  • USE_HARD_API_V2:1

Although the API is designed for use in POST requests, it can be used for GET requests in a limited mode.

Call format:

{{Server}}/api/v2/{{MethodName}}

Example:

http://194.1.237.94/api/v2/GenerateKeys

As a result, JSON is returned, which contains the required result field with the value:

  • 0 - the request contains errors or the result is not possible to get (for example, there is no such account),
  • 1 - successful execution of the query

text - the optional field contains a detailed description of the result

All methods support the Meta parameter, if it is specified, the same value is added to the query result. This is useful for organizing your own query routing, often used in micro-service architectures.

GenerateKeys

1)/api/v2/GenerateKeys - create private key - public key pair

Parameters are not required

example:

http://127.0.0.1/api/v2/GenerateKeys

return:

{
    "result": 1,
    "PrivKey": "65C65BE3F436DE58C64461BDC1BF0E2D8AB06C2C4E92470B1F4CDEADB9B2C3FF",
    "PubKey": "030809551AD9E0E275082C75EC82E9651BF062821EC6DFE31039B0EDE6A2ED26CC"
}

CreateAccount

2)/api/v2/CreateAccount - create a new account (account). In Tere free account creation is possible only in the intervals of 10 seconds. The paid version is given in the example of 2 methods Send

Parameters:

  • Name - account name up to 40 bytes
  • PubKey - public key in hex-format

example:

http://127.0.0.1/api/v2/CreateAccount
{
    "Name": "Hellow, world",
    "PubKey": "0240EDF5ECB25D886FD58DB92A53914FAC975078C1C2EDD1AC292B70C7BC13461F"
}

return:

{"result":1,"text":"Added to timer","TxID":"DC316BD766AC654E0AF7260F2E010000","BlockNum":19795750}

Send

3)/api/v2/Send - sending coins from one account to another (you need to specify the private key of the sender's account)

Parameters:

  • FromID - the account number of the sender
  • FromPrivKey - sender private key in hex format
  • ToID - the account number of the recipient, the number or public key in hex format (in this case, it will create a new account with the name specified in the first line of the description of the payment and the payment the account will be charged 10 Tera)
  • Amount - sum, floating-point number, or object format {SumCOIN,SumCENT}
  • Description - description of payment order (optional)

example1:

http://127.0.0.1/api/v2/Send
{
    "FromID": 190085,
    "FromPrivKey": "A2D45610FE8AC931F32480BFE3E78D26E45B0A4F88045D6518263DA12FA9C033",
    "ToID":190165,
    "Amount":10.5,
    "Description":"Test"
   
}

example2 (create a new account):

http://127.0.0.1/api/v2/Send
{
    "FromID": 190085,
    "FromPrivKey": "A2D45610FE8AC931F32480BFE3E78D26E45B0A4F88045D6518263DA12FA9C033",
    "ToID":"0240EDF5ECB25D886FD58DB92A53914FAC975078C1C2EDD1AC292B70C7BC13461F",
    "Amount":10,
    "Description":"New account"
   
}

return:

{"result":1,"text":"OK","TxID":"BE10810FDE7A1317D9DF51D62D010000","BlockNum":19781201}

GetBalance

4)/api/v2/GetBalance - get account balance

Parameters:

  • AccountID - account number

example:

http://127.0.0.1/api/v2/GetBalance
{
    "AccountID": 0
}

return:

{
    "result": 1,
    "SumCOIN": 580222966,
    "SumCENT": 527313901
}

GetTransaction

5)/api/v2/GetTransaction - get transaction (returns an object with the contents of the transaction)

Parameters:

  • TxID - Transaction ID in hex format

example:

http://127.0.0.1/api/v2/GetTransaction
{
    "TxID": "BE10810FDE7A1317D9DF51D62D010000"
}

return:

{
    "Type": 111,
    "Version": 3,
    "Reserve": 0,
    "FromID": 190085,
    "To": [
        {
            "PubKey": "",
            "ID": 190165,
            "SumCOIN": 1,
            "SumCENT": 0
        }
    ],
    "Description": "New6",
    "OperationID": 41,
    "Body": "",
    "Sign": "8C761F539A6A24427CF810A49140CA1FFBF0F3A48DCF58AEE0DD9E4A4E631E1A1B6DA86ED6E2EF92DBF537270AA02B5EAE3A7C822B3F70628CAD78525ED9E0F7",
    "result": 1
}

GetHistoryTransactions

6)/api/v2/GetHistoryTransactions - to get the transaction history of the account

TODO