Skip to content

Commit 18e1561

Browse files
committed
Update version and references to API docs
1 parent 76f1263 commit 18e1561

File tree

4 files changed

+8
-14
lines changed

4 files changed

+8
-14
lines changed

GUIDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Using the BitPay Python client
22

3-
This SDK provides a convenient abstraction of BitPay's [cryptographically-secure API](https://bitpay.com/api) and allows payment gateway developers to focus on payment flow/e-commerce integration rather than on the specific details of client-server interaction using the API. This SDK optionally provides the flexibility for developers to have control over important details, including the handling of private keys needed for client-server communication.
3+
This SDK provides a convenient abstraction of BitPay's [cryptographically-secure API](https://developer.bitpay.com/reference/concepts) and allows payment gateway developers to focus on payment flow/e-commerce integration rather than on the specific details of client-server interaction using the API. This SDK optionally provides the flexibility for developers to have control over important details, including the handling of private keys needed for client-server communication.
44

55
It also implements BitPay's remote client authentication and authorization strategy. No private or shared-secret information is ever transmitted over the wire.
66

@@ -47,9 +47,9 @@ pip install bitpay
4747

4848
### Handling your client private key
4949

50-
Each client paired with the BitPay server requires a ECDSA key. This key provides the security mechanism for all client interaction with the BitPay server. The public key is used to derive the specific client identity that is displayed on your BitPay dashboard. The public key is also used for securely signing all API requests from the client. See the [BitPay API](https://bitpay.com/api/) for more information.
50+
Each client paired with the BitPay server requires a ECDSA key. This key provides the security mechanism for all client interaction with the BitPay server. The public key is used to derive the specific client identity that is displayed on your BitPay dashboard. The public key is also used for securely signing all API requests from the client. See the [BitPay API](https://developer.bitpay.com/reference/concepts) for more information.
5151

52-
The private key should be stored in the client environment such that it cannot be compromised. If your private key is compromised you should revoke the compromised client identity from the BitPay server and re-pair your client, see the [API tokens](https://bitpay.com/api-tokens) for more information.
52+
The private key should be stored in the client environment such that it cannot be compromised. If your private key is compromised you should revoke the compromised client identity from the BitPay server and re-pair your client, see the [API tokens](https://developer.bitpay.com/reference/concepts#api-tokens) for more information.
5353

5454
To generate the configuration file required to load the SDK:
5555

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@
44
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/bitpay/python-bitpay-client/master/LICENSE)
55
[![PyPI](https://img.shields.io/pypi/v/bitpay.svg?style=flat-square)](https://pypi.org/project/bitpay)
66

7-
Full implementation of the BitPay Payment Gateway. This library implements BitPay's [Cryptographically Secure RESTful API](https://bitpay.com/api).
8-
9-
Our Lite version will most likely be all you need to integrate to your site, available [here](https://github.com/bitpay/python-bitpay-light-client)
10-
11-
## Getting Started
12-
13-
To get up and running with our Python library quickly, follow [The GUIDE](https://github.com/bitpay/python-bitpay-client/blob/master/GUIDE.md)
7+
Full implementation of the BitPay Payment Gateway. This library implements BitPay's [Cryptographically Secure RESTful API](https://developer.bitpay.com/reference/concepts).
148

159
## Support
1610

src/bitpay/client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
package Bitpay
44
author Antonio Buedo
55
version 4.0.0
6-
See bitpay.com/api for more information.
6+
See https://developer.bitpay.com/reference/concepts for more information.
77
"""
88
import os
99
import json
@@ -48,8 +48,8 @@ class Client:
4848
* Class Client
4949
* @package Bitpay
5050
* @author Antonio Buedo
51-
* @version 3.4.2203
52-
* See bitpay.com/api for more information.
51+
* @version 4.0.0
52+
* See https://developer.bitpay.com/reference/concepts for more information.
5353
"""
5454

5555
__bitpay_client: BitPayClient

src/bitpay/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ class Config(Enum):
55
TEST_URL = "https://test.bitpay.com/"
66
PROD_URL = "https://bitpay.com/"
77
BITPAY_API_VERSION = "2.0.0"
8-
BITPAY_PLUGIN_INFO = "BitPay_Python_Client_v4.0"
8+
BITPAY_PLUGIN_INFO = "BitPay_Python_Client_v4.0.0"
99
BITPAY_API_FRAME = "std"
1010
BITPAY_API_FRAME_VERSION = "1.0.0"

0 commit comments

Comments
 (0)