Leal Python SDK

Install

pip install leal-sdk

Your first call

Create a token at app.getleal.com/api_tokens, keep it in an environment variable, and hand it to the client once. Every request after that carries it for you.

import os
from leal import Leal

leal = Leal(token=os.environ["LEAL_API_TOKEN"])

stores = leal.stores.list()
print(stores[0].name)

A token reaches every store its owner belongs to. There is no separate sandbox yet, so build against a store you do not mind changing.

Common tasks

from leal.customers import CreateCustomersRequestCustomer

customer = leal.customers.create(
    account_id=store_id,
    customer=CreateCustomersRequestCustomer(
        first_name="Ada",
        email="ada@example.com",
    ),
    card_id=card_id,
)

card = customer.customer_cards[0]
print(card.apple_wallet_url, card.google_wallet_url)

card = leal.customer_cards.stamp(
    account_id=store_id,
    customer_id=customer_id,
    id=customer_card_id,
    stamps=1,
)

print(card.stamps_remaining, "stamps to the next reward")

leal.customer_cards.redeem(
    account_id=store_id,
    customer_id=customer_id,
    id=customer_card_id,
    reward_id=reward_id,
)

from leal.core.api_error import ApiError

try:
    leal.customer_cards.stamp(
        account_id=store_id, customer_id=customer_id, id=customer_card_id, stamps=1
    )
except ApiError as error:
    if error.status_code == 429:
        pass  # Wait for the seconds in the Retry-After header, then try again.
    raise

Every endpoint is available, not just these. The Python repository lists them all, and the API reference documents each field.

Rate limits and retries

Leal allows 300 requests per minute per API token. The client retries a failed request on its own, backing off between attempts, so a brief wobble does not need handling in your code. Go past the limit and you get a 429 carrying Retry-After in seconds. If you need a higher limit, ask us.