get_brand_kit
Get brand kit from a website
Reads a business's public website and returns its name, a colour palette (with where each colour was found; colours read from the logo are the most reliable, and website-builder default colours are filtered out), logo and icon image URLs, a hero image, a guess at the type of business, and a suggested starting card design built from those. Works without a Leal account. Use the result to propose card designs with preview_card_designs.
輸入參數url必填
list_design_options
List card design options
Lists what a Leal loyalty card can look like: stamp icons, preset strip photos, limits, and how the pass is laid out on Apple and Google Wallet. Works without a Leal account.
無需輸入參數。
preview_card_designs
Preview loyalty card designs
Renders one to four loyalty card designs as Apple Wallet and Google Wallet passes so the person can compare them and pick one. Checks each design against Leal's rules and flags hard-to-read colour combinations. Returns a shareable preview link per design. Works without a Leal account; nothing is saved.
輸入參數designs必填store_name
Lists the Leal stores this login can manage, with each store's id, plan and how far through setup it is, and the agencies it can add new stores to with create_store.
無需輸入參數。
get_store_setup
Get store setup
Shows a store's setup checklist (store details, card, poster, first customer, staff app), plan limits and usage, and its cards with rewards, locations and posters.
輸入參數store_id
list_cards
List loyalty cards
Lists a store's loyalty cards with their rewards.
輸入參數store_idinclude_archived
get_card
Show a loyalty card
Shows a saved loyalty card's design and rewards, with an Apple and Google Wallet preview.
輸入參數card_id必填
create_store
Create a store
Adds a new, empty store to the login's agency, with its own cards, posters and locations: for a client, a second business, or a demo to show a prospect. Then set it up with create_card, create_poster and create_location using the returned store_id. Don't use this to set up a store the login already has: call list_stores first and use the existing store if it's the same business.
輸入參數name必填logo_urlagency_idstore_namesquare_logo_url
update_store
Update store name and logo
Sets a store's public name and logos, which Leal uses on cards, posters and signup pages. Logos are fetched from public image URLs (PNG, JPEG, WebP, GIF or SVG). Replaces the current values.
輸入參數logo_urlstore_idstore_namesquare_logo_url
create_card
Create a loyalty card
Saves a loyalty card design and its rewards to a Leal store, ready for customers to add to Apple Wallet or Google Wallet. Takes the same design fields as preview_card_designs. Logos and strip photos are fetched from their URLs; if the store has no logo yet, the card's logo becomes the store logo. Needs a Leal account: the person is asked to sign in or create one.
輸入參數name必填rewards必填logo_urlstore_idcard_colorstamp_iconstrip_typetext_colorheader_textstamp_colorstrip_colorstrip_preset另有 9 個
update_card
Update a loyalty card
Changes a saved card's design. Only the fields passed change; the rest stay as they are. Customers' passes in Apple Wallet and Google Wallet update automatically.
輸入參數namecard_id必填logo_urlcard_colorstamp_iconstrip_typetext_colorheader_textstamp_colorstrip_colorstrip_presetstrip_opacity另有 8 個
create_reward
Add a reward to a card
Adds a reward that customers can redeem with stamps from a card, e.g. a free coffee at 10 stamps.
輸入參數name必填card_id必填descriptionstamps_required必填
update_reward
Update a reward
Changes a reward's name, stamps needed or description, or turns it off. Only the fields passed change.
輸入參數nameactivereward_id必填descriptionstamps_required
create_location
Add a store location
Adds a physical location to a store. The address is geocoded so wallet passes can remind customers nearby.
輸入參數name必填address必填store_id
create_poster
Create a signup poster
Creates a printable poster with a QR code for a card. Customers scan it, fill in a short form on a public Leal signup page, and add the card to their wallet. Returns the signup link and a print link. Colours default to the card's.
輸入參數titlecard_id必填paper_sizetext_colorprimary_colorsecondary_colorrequire_birthdaycontact_collection_mode