add api doc

docs/api.md

@@ -1,2 +1,163 @@
 API
-=====
+=====
+
+## Status Endpoints
+### Get Bitsign Status [GET /status]
+This endpoint returns Bitsign blockchain status, latestblock, bootnodes, etc.
+
+## User Endpoints
+### User Info [GET /api/v2/user?email={email}&password={password}]
+This endpoint retrieves token and Ethereum keys needed to interact with the rest of the endpoints.
+**Email** and **password** parameters must be provided.
+
++ Parameters
+
+    + email: alice@crypto.com (string) - Unique email address.
+    + password: some_crafty_password (string) - User Password
+
+### New User [POST /api/v2/user]
+Create new user trough our API to get token access and pre-configured Ethereum keys.
+With the token you can query all other endpoints and interact with all blockchains and the Smart Contracts.
+
++ Request (application/json)
+
+        {
+            "email": "",
+            "password": "",
+            "username": ""
+        }
+
+### Change Password [PUT /api/v2/user]
+This endpoint allow the user to changes their password. You must send the old password and the new one that must respect our security policies.
+
++ Request (application/json)
+
+        {
+            "email": "alice@crypto.com",
+            "password": "crafty_password!",
+            "newPassword": "new_crafty_password"
+        }
+
+## Transaction Endpoints
+### Notarization TX [POST /eth/notarizetx]
+This endpoints uses data field input to create a **notary transaction** and include it in a new block.
+Transactions from this endpoints will be executed **from Bitsign's main node** to facilitate its creation.
+If you want to create your own transaction and send it from your account please use **sendRawTX endpoint instead**.
+
++ Request (application/json)
+
+        {
+            "token": "<your_token>",
+            "data": "<some_hexadecimal_data>",
+            "address": "<your_ethereum_address>",
+            "password": "<your_password>"
+        }
+
+## Raw Transactions Endpoints
+### SendRawTransaction [POST /eth/signedRawTx]
+If you don't trust or don't want to use the **keypair provided by Bitsign**, you can always call this endpoint that will publish your **offline
+signed** raw [transaction](https://web3js.readthedocs.io/en/1.0/web3-eth.html#sendsignedtransaction). Bitsign node will only handle gas cost and transaction publication,
+but you have to **craft the entire transaction** on your end.
+We will be releasing Bitsign tx library to facilitate this process soon.
+
+
++ Request (application/json)
+
+        {
+            "token": "",
+            "env": "",
+            "tx": ""
+        }
+
+## Smart Contract Endpoints
+### Deploy new Smart Contract [PUT /eth/contract]
+This endpoint allow the user to deploy a new smart contract. The available smart contracts are:
+
+##### Notarize
+This smart contract allow the user to notarize documents.
+###### Constructor
+In order to initialize Notarize contract the user must send an address, that will be set as the owner of the contract. The owner will be the only one that is able to notarize.
+###### Methods
+* notarize: This method receive as a parameter a bytes32 that will be the evidence to be notarized. The owner of the contract will be the only one that is capable of execute this method. If the sender is not the owner, the tx will be reverted. After the evidence is notarized the Notary event will be raised with two parameters: the evidence and the address.
+
+##### Escrow
+This smart contract allow the user to deposit founds in the smart contract and define a buyer, a seller and an arbiter. Each actor can release the found to the other part based on pre established conditions.
+###### Constructor
+In order to initialize Escrow contract the user must send _seller (address), _buyer (address) and _endTime (uint). The sender of the transaction will be the arbiter of the contract. The arbiter act as an impartial third party. Also the value should be passed in order to set funds on the contract.
+###### Methods
+* pay: This method can be executed by the buyer or the arbiter. This method will transfer the balance of the contract to the seller address. After that, it will raise the Payout event with two parameters: balance and seller address.
+* refund: This method can be executed by the seller or the arbiter. This method will transfer the balance of the contract to the buyer address. After that, it will raise the Refund event with two parameters: balance and buyer address.
+* getBalance: This method will return the balance of the contract. It can be executed by any member of the contract.
+* kill: This method can be executed by the arbiter only. It will destruct the contract and send the balance of the contract to its address.
+
+#####  NotarizeTX
+###### Constructor
+In order to initialize NotarizeTx contract the user must send the following values:
+buyer (address),
+seller (address),
+id  (bytes32),
+date (string),
+value (uint),
+hash (bytes32),
+status (string),
+shipping (string)
+###### Methods
+* updateStatus: This method can be executed by the buyer or the BSG node. Also it checks that the id passed is the same as one that user sent when deployed. The parameters of this method are status (string), hash (bytes32) and id (bytes32). The main purpose of this method is to update the tx status. After the method notarize the new tx, it raise the NotaryEvt event with the parameters: hash (bytes32) and id (bytes32).
+* updateShipping: This method can be executed by the buyer or the BSG node. Also it checks that the id passed is the same as one that user sent when deployed. The parameters of this method are status (string), hash (bytes32) and id (bytes32). The main purpose of this method is to update the tx shipping. After the method notarize the new tx, it raise the NotaryEvt event with the parameters: hash (bytes32) and id (bytes32).
+
++ Request (application/json)
+
+        {
+            "token": "",
+            "env": "production",
+            "args": {
+                "_buyer": "",
+                "_seller": "",
+                "_endTime": 314159
+            },
+            "type": "Escrow",
+            "value": "0",
+            "password": "<your_password>"
+        }
+
+### Contract Usage [GET /eth/contract/doc?token={token}&type={type}]
+This endpoint returns smart contract's ABI and functions to use its functionality.
+
++ Parameters
+
+    + token: <user_token> (string) - User token.
+    + type: <contract_name> (string) - Smart Contract type.
+
+### Call Contract Method [POST /eth/contract]
+
+This endpoint allow the user to read the state from the blockchain using contract methods.
+This endpoint will not alter blockchain state and therefore wont cost gas.
+
++ Request (application/json)
+
+        {
+            "token": "",
+            "address": "",
+            "env": "",
+            "method": "",
+            "args": {}
+        }
+
+### Execute Contract Method[PATCH /eth/contract]
+
+This endpoint allow the user to send a transaction to the node and therefore modify the blockchain state.
+Altough this method will generally cost gas, there is no limitation about it when using BSG Chain and gast cost will be handled internally.
+
+
++ Request (application/json)
+
+        {
+            "token": "",
+            "address": "<contract_address>",
+            "env": "production",
+            "method": "pay",
+            "args": {
+
+            },
+            "password": "<your_password>"
+        }