GETTING STARTED

Installing ECS could not be easier.

Step 1: Sign up

Go the following URL and follow the sign up instructions.

Step 2: Add email

Add a valid email address. Whenever you receive and order we will send the details of the order to this email address.

Step 3: Add Bitcoin address

Add a Bitcoin address, this is the address we will send the funds to after you make a sale. We never keep your funds on the full node longer than we have to, as soon as we have 3 confirmations we forward the funds on to you.

Step 4: Copy the code

Copy the code from this step and add it to your website.

Step 5: Add code to your website

This is an example of the code you will get something like the following output.

Step 5a: Payment button

Let us take a look at the payment button as you see this is a simple <a> tag. It can be any html element you want and can be styled how you want it, that is none of our business. As you can it has a number of unique parameters which we will break down here.

We currently support 2 cart types

This is the class that tells ECS that this is a payment button.

This is the price you want to charge for the product. ECS will use this to either update a product in the database or create a new one with this price if one is not found. The price is in Satoshi's.

This is the name of the product. ECS will use this to either update a product in the database or create a new one with this price if one is not found.

This is a preview image that it will use in the cart. This is an optional setting

Step 5b: Initialisation code

This is the code you place in the footer of your website to load the ECS cart and be able to take payments in Bitcoin. It has a number of configuration options let us take a look at them.

server url

The first one is the URL of the ECS server. Currently we have 2 ECS urls one the bitcoin testnet and one for the mainnet. Please use the correct one to serve your requirements.

Testnet

Mainnet

quantity

This parameter controls the max quantity of the product you can buy.

uid

This parameter is your unique ID you got whilst signing up.

cdn url

This parameter is the url that hosts the ECS cart's theme

shipping address

This parameter is a boolean that sets if you want to capture a shipping address

serverless

This parameter is a boolean mode that sets serverless mode. Basically when you run this you do not require a full node or ECS to be running it uses the simply sends the funds to the BTC address that you specify.

Note, this does not validate the transactions so it is not the safest way to run a BTC ecommerce on your site. However it does allow you to run ECS on static sites and you do not have to have an ECS server or a full node running.

Note, you cannot use Lightning in serverless mode.

serverless BTC address

This parameter sets the BTC address that the funds are to be sent to.

lightning

This parameter is a boolean to set use Lightning or not.

Last updated

Was this helpful?