Getting Started

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'}