https://github.com/mattlisiv/clover-api-python
A Python Client for Clover API v3
https://github.com/mattlisiv/clover-api-python
api api-client clover clover-api point-of-sale python v3
Last synced: about 1 month ago
JSON representation
A Python Client for Clover API v3
- Host: GitHub
- URL: https://github.com/mattlisiv/clover-api-python
- Owner: mattlisiv
- License: mit
- Created: 2018-01-17T19:08:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-19T19:43:17.000Z (about 5 years ago)
- Last Synced: 2026-01-05T15:52:29.758Z (5 months ago)
- Topics: api, api-client, clover, clover-api, point-of-sale, python, v3
- Language: Python
- Size: 30.3 KB
- Stars: 12
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Clover API Wrapper in Python #
Python client for Clover Point Of Sale [API V3](https://www.clover.com/api_docs/)
##### Provided under MIT License by Matt Lisivick.
*Note: this library may be subtly broken or buggy. The code is released under
the MIT License – please take the following message to heart:*
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## General
This is a Python client library for Clover API v3
## Installation
Installation for the package can be done via pip.
```commandline
pip install cloverapi-python
```
## Usage
Initialize the client with your API key:
```python
from cloverapi.cloverapi_client import CloverApiClient
api_client = CloverApiClient(api_key='XXXXXXXX', merchant_id='XXXXXXXX',
api_url='https://apisandbox.dev.clover.com')
```
#### Making a request
Each API call should have a related method
For instance:
GET /v3/merchants/{mId}
maps to:
```python
api_client.merchant_service.get_merchant()
```
Each main category on the Clover documentation:
- Merchants ```api_client.merchant_service```
- Cash ```api_client.cash_service```
- Customers ```api_client.customer_service```
- Employees ```api_client.employee_service```
- Inventory ```api_client.inventory_service```
- Notifications ```api_client.notification_service```
- Orders ```api_client.order_service```
- Payments ```api_client.payment_service```
- Apps ```api_client.app_service```