Context aware client with no external dependencies. Enrol customers, add stamps, redeem rewards and read a card's Apple Wallet and Google Wallet links, without writing a single HTTP request.
go get github.com/lealhq/leal-go-sdkCreate 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 (
"context"
"os"
client "github.com/lealhq/leal-go-sdk/client"
"github.com/lealhq/leal-go-sdk/option"
)
leal := client.NewClient(option.WithToken(os.Getenv("LEAL_API_TOKEN")))
stores, err := leal.Stores.List(context.TODO())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.
Create the customer and put them straight onto a card. The response carries the Apple Wallet and Google Wallet links, so you can send them yourself.
customer, err := leal.Customers.Create(ctx, &api.CreateCustomersRequest{
AccountID: storeID,
Customer: &api.CreateCustomersRequestCustomer{
FirstName: "Ada",
Email: api.String("ada@example.com"),
},
CardID: api.Int(cardID),
}) The call most integrations need. Leal records the stamp, updates the wallet pass and sends the notification.
card, err := leal.CustomerCards.Stamp(ctx, &api.StampCustomerCardsRequest{
AccountID: storeID,
CustomerID: customerID,
ID: customerCardID,
Stamps: 1,
}) Spend the stamps a customer has earned. Leal checks the reward is available before recording the redemption.
_, err := leal.CustomerCards.Redeem(ctx, &api.RedeemCustomerCardsRequest{
AccountID: storeID,
CustomerID: customerID,
ID: customerCardID,
RewardID: rewardID,
}) Errors work with errors.As and carry the status code, so you can tell a missing record from a rate limit without reading strings.
if err != nil {
var apiError *core.APIError
if errors.As(err, &apiError) && apiError.StatusCode == 429 {
// Wait for the seconds in the Retry-After header, then try again.
}
return err
} Every endpoint is available, not just these. The Go repository lists them all, and the API reference documents each field.
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.
The same API, the same methods, in eight other languages.