btcpayserver/btcpayserver-php-client
btcpayserver/btcpayserver-php-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
master
btcpayserver-php-client/docs/installation.md

1.3 KiB
Raw Permalink Blame History

Installation

Composer

Add the following to your composer.json

"require": {
    "btcpayserver/btcpayserver-php-client": "~0.1.0"
}

Note

To obtain the LATEST development code which is on the master branch you can either update your minimum-stability setting or put the version as ~0.1.0@dev

Once you have added this to your composer.json file you will need to install the library in your project.

php composer.phar update btcpayserver/btcpayserver-php-client

Composer Alternative

By running this composer command, you will add the library to composer.json and install the latest version.

php composer.phar require "btcpayserver/btcpayserver-php-client"

Setup

Before you begin to use the API, you will need to create public/private keys and pair them to your account. The command line tool was made to help you generate your keys and to pair them. Before you can make any request that is not open to the public, you will need to do this.

Note

You will need to create and pair your keys before you can start creating invoices and doing other things with the API that are not open to the public.