Git Product home page Git Product logo

clover-api-python's Introduction

Clover API Wrapper in Python

Python client for Clover Point Of Sale API V3

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.

    pip install cloverapi-python

Usage

Initialize the client with your API key:

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:

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

clover-api-python's People

Contributors

davidthegreat avatar jefftriplett avatar mattlisiv avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.