Add API doc

gnosis · Jul 17, 2018 · 69c20ab · 69c20ab
1 parent b1dd281
commit 69c20ab
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/source/api.md b/source/api.md
@@ -0,0 +1,19 @@
+# Public API
+The API is an alternative and easier access to the information on
+the smart contracts.
+
+It was built to make the information more accessible, so it hides the barriers 
+that a newcomer may find in the Ethereum development.
+
+The API is accesible for:
+  * **Mainnet**: [https://dutchx.d.exchange/api](https://dutchx.d.exchange/api)
+  * **Rinkeby**: [https://dutchx-rinkeby.d.exchange/api](https://dutchx-rinkeby.d.exchange/api)
+
+The API is Open Source, so anyone can run it in it's own server.
+
+It provides read-only access. For any operation that needs to write in the 
+blockchain, you'll need to do it using your own node (or infura). Checkout 
+how to do this by reading [Build on top of the Dutch Exchange](./build-on-top-of-dutchx.html)
+
+The API logic is implemented in the [DutchX Services](https://github.com/gnosis/dx-services),
+for more information checkout [DutchX as an open platform](./dutchx-as-an-open-platform.html)
diff --git a/source/dutchx-as-an-open-platform.md b/source/dutchx-as-an-open-platform.md
@@ -31,7 +31,7 @@ to be performed in the smart contract, so they can throw more meaninful errors,
 instead of the `revert` that smart contracts throw.
 * **Services**: Some use cases built on top of the DutchX
 * **API**: REST Api that provides a simpler access to the data in the DutchX.
-[https://dutchx.d.exchange/api]()
+Check out the [API documentation](./api.html)
 * **CLI**: The Command Line Interface it's a very useful tool for invoking some
 operations in the smart contracts such as posting sell/buy orders, and to 
 extract some information from them (for example getting the status of a token 

diff --git a/source/index.rst b/source/index.rst
@@ -36,6 +36,8 @@ check out the :download:`DutchX Documentation <./_static/docs/DutchX_Documentati
    smart-contract-documentation
    dutchx-as-an-open-platform
    market-makers
+   api
+   use-the-cli
    security-of-the-contracts
    contribute
 
@@ -45,7 +47,6 @@ check out the :download:`DutchX Documentation <./_static/docs/DutchX_Documentati
 
    build-on-top-of-dutchx
    use-dutchx-as-an-oracle
-   use-the-cli
    Add a token pair <add-token-pair>
    Run your own bots <run-your-own-bots>