Skip to main content

A wrapper for the AMcards API.

Project description

https://i.ibb.co/tCrVfj6/readthedocs.png

Installation

To install python-amcards, simply run this command in your terminal:

$ pip install python-amcards

Usage

All interactions with the AMcards API are made through the AMcardsClient class.

First, create an AMcardsClient as follows:

>>> from amcards import AMcardsClient
>>> client = AMcardsClient('youraccesstoken')

Here 'youraccesstoken' will be replaced with a string containing your AMcards access token. You can generate one here.

Now we can perform all operations supported by the client.

Let’s try using send_card to send a card to a single recipient:

>>> res = client.send_card(
...     template_id='123',
...     initiator='myintegration123',
...     shipping_address={
...         'first_name': 'Ralph',
...         'last_name': 'Mullins',
...         'address_line_1': '2285 Reppert Road',
...         'city': 'Southfield',
...         'state': 'MI',
...         'postal_code': '48075',
...         'country': 'US'
...     }
... )
>>> res.card_id
1522873
>>> res.total_cost
442
>>> res.message
'Card created successfully!'
>>> res.user_email
'example@example.com'
>>> res.shipping_address
{'last_name': 'Mullins', 'address_line_1': '2285 Reppert Road', 'first_name': 'Ralph', 'country': 'US', 'state': 'MI', 'postal_code': '48075', 'city': 'Southfield'}

The AMcardsClient supports many more operations, for full documentation see Read the Docs.

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

python_amcards-1.3.0.tar.gz (20.7 kB view hashes)

Uploaded Source

Built Distribution

python_amcards-1.3.0-py3-none-any.whl (21.4 kB view hashes)

Uploaded Python 3

Supported by

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