Skip to main content

A Python SDK designed to wrap around the Partnero API.

Project description

Partnero SDK

The Partnero SDK provides a simple and powerful Python interface to the Partnero API, allowing developers to manage customers, partners, transactions, webhooks, coupons, and promotion codes programmatically. It simplifies interactions by providing a centralized client (PartneroClient) that handles configuration and request management.

Partnero API Documentation

Installation

To install the Partnero SDK, run the following command:

pip install partnero

Configuration

Before using the SDK, configure the PartneroClient with your API token:

from partnero import PartneroClient

# Replace 'your_api_token_here' with your actual API token
client = PartneroClient(api_key='your_api_token_here')

Usage

With PartneroClient, you can easily access different parts of the Partnero API. Here's how you can use it to manage customers, partners, transactions, and webhooks:

Customer Management

List Customers

customers = client.customers.list_customers(limit=10, page=1)
print(customers)

Create a New Customer

new_customer = client.customers.create_customer(
    partner_key='your_partner_key',
    customer_key='unique_customer_key',
    email='customer@example.com',
    name='Customer Name'
)
print(new_customer)

Partner Management

List Partners

partners = client.partners.list_partners(limit=5, page=1)
print(partners)

Register a New Partner

new_partner = client.partners.create_partner(
    email='newpartner@example.com',
    name='New Partner',
    password='securepassword123'
)
print(new_partner)

Transaction Management

List Transactions

transactions = client.transactions.list_transactions(limit=5, page=1)
print(transactions)

Create a Transaction

new_transaction = client.transactions.create_transaction(
    customer_key='customer_key',
    transaction_key='unique_transaction_key',
    amount=39.99,
    product_id='product_id',
    product_type='type',
    action='purchase'
)
print(new_transaction)

Webhook Management

List Webhooks

webhooks = client.webhooks.list_webhooks(limit=5, page=1)
print(webhooks)

Create a Webhook

new_webhook = client.webhooks.create_webhook(
    name='Order Placed',
    url='https://yourdomain.com/webhooks/order_placed',
    events=['order_placed'],
    is_active=True
)
print(new_webhook)

Contributions

Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.

License

This SDK is released under the MIT License. See the LICENSE file for more details.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

partnero-0.3.0.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

partnero-0.3.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file partnero-0.3.0.tar.gz.

File metadata

  • Download URL: partnero-0.3.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for partnero-0.3.0.tar.gz
Algorithm Hash digest
SHA256 36688fdd8476041dd3728d51bed9cf6451d961a6ad495bdbde25467f56fd0bf8
MD5 186979f57ffdcdf59d186fca575f0a66
BLAKE2b-256 160fea378e37048ac2d4a1c98a9c5cc825dd70d7d873b95b855b1760779ddb1b

See more details on using hashes here.

File details

Details for the file partnero-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: partnero-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for partnero-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d182198b6d4fa2a66f3166605f7b17d210208384f74b878742243252927c76f2
MD5 a3cb76559b697ab2d149f3cf670732c1
BLAKE2b-256 41b9f8ea5fd3728a09cb915248d2b9388bbc44638094018841332c2d29f21499

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page