canonical: https://jentic.com/apis/clienttoolbox.com/loyalty-gator-api

# Clienttoolbox Loyalty Gator API

Jentic publishes the only available OpenAPI specification for Loyalty Gator API, keeping it validated and agent-ready. Loyalty Gator is a customer loyalty program platform from Client Toolbox, exposing a single dispatch endpoint that accepts a request_type form field to drive operations on customers, transactions, rewards, and campaigns. Authentication uses an api_access_key header. This index entry covers the dispatch endpoint; the full request_type catalogue is documented in the clienttoolbox.com main API spec.

## For AI agents

Run loyalty program actions - enrol customers, post point transactions, redeem rewards, and trigger campaigns - through a single dispatch endpoint at /api.php.

## Scope

Does not handle payment processing, ticketing, or full CRM workflows - use for loyalty program dispatch operations only.

## Capabilities

- Dispatch loyalty program operations through a single POST /api.php endpoint
- Authenticate every call with the api_access_key header for tenant isolation
- Submit request_type form fields to route between customer, transaction, and reward operations
- Pair with the clienttoolbox.com main spec for the full operation catalogue
- Build a thin agent shim that maps natural language onto request_type values

## Use cases

### Single-Endpoint Loyalty Dispatch

Developers integrating loyalty into a checkout flow can call POST /api.php with the appropriate request_type form field - for example a customer lookup or a points award - and receive a JSON response. Because every operation runs through one endpoint, network and auth handling can be shared across all loyalty interactions. The trade-off is that the agent must select the right request_type for the action.

Example prompt: POST to /api.php with api_access_key header set and form fields request_type=customer_info plus customer_id=12345 to fetch a customer record.

### Index Spec for Catalogue Browsing

Catalogue and discovery tools that need a stable handle for the Loyalty Gator product can use this index spec to surface a single tile, then deep-link to the full request_type catalogue in the clienttoolbox.com main spec. This keeps marketplace listings clean while preserving the rich operation set for agents that need it.

Example prompt: Show the Loyalty Gator tile on the catalogue, and on click route to the clienttoolbox.com/main entry for the full per-request_type operation list.

### AI Agent Loyalty Action via Jentic

Agent builders can register Loyalty Gator through Jentic and call /api.php with a request_type chosen at run time. Jentic stores the api_access_key server-side, so the agent receives a scoped token rather than the raw key, and the agent can compose the form body from a natural-language instruction. For full per-action operations, agents typically use the clienttoolbox.com/main spec instead.

Example prompt: Search Jentic for 'execute a loyalty gator request', load the POST /api.php schema, and execute with request_type and the form fields supplied by the user.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api.php` | Execute a Loyalty Gator API request, with the operation selected by the request_type form field |

## Key resources

- **Dispatch endpoint** — POST /api.php - single endpoint that routes to all loyalty operations via the request_type form field.

## Why Jentic

- **Setup:** Wiring the Loyalty Gator API by hand means setting the api_access_key header on every call to api.clienttoolbox.com and packing the request_type and its fields into a single POST /api.php form yourself. Through Jentic you install once, import the Loyalty Gator API from the API Directory, store the access key once, and your agent calls it.
- **Permission scoping:** Loyalty Gator routes everything through POST /api.php with the request_type and parameters in the form body, so scope the agent to the operations it needs. You choose which request types are in the allowed set, so anything outside it is not callable.
- **Credential handling:** Your Loyalty Gator access key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'execute a Loyalty Gator request', and Jentic returns the POST /api.php operation with its form-field schema so the agent fills request_type and the operation parameters together without browsing the reference docs.

## Related APIs

- **Loyalty Gator API** — Same product, modelled with one path per request_type for fine-grained agent operations.
- **LoyaltyLion API** — Loyalty platform focused on Shopify and e-commerce stores.
- **Yotpo API** — Reviews, loyalty, and SMS platform for e-commerce brands.

## FAQ

### Why is there no official OpenAPI spec for Loyalty Gator API?

Client Toolbox does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Loyalty Gator API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Loyalty Gator API use?

Every request to /api.php must include the api_access_key header. Through Jentic, the key is stored in the vault and never enters the agent's context - the agent receives a scoped execution token instead.

### How does the single /api.php endpoint route between operations?

Operations are selected by the request_type form field on POST /api.php (for example customer_info, transaction_add, reward_redeem). For the full catalogue of request_type values, use the clienttoolbox.com/main spec, which models each request_type as a distinct path.

### Can I post a loyalty transaction with the Loyalty Gator API?

Yes. POST /api.php with request_type set to a transaction operation and the customer and points fields in the form body. The detailed transaction request_type catalogue lives in the clienttoolbox.com/main spec.

### What are the rate limits for the Loyalty Gator API?

Client Toolbox does not publish explicit rate limits in the spec. SSL is mandatory and limits are enforced per account. Handle 429 responses with backoff and check current quotas with Client Toolbox support for your tier.

### How do I call Loyalty Gator through Jentic?

Run pip install jentic, then search for 'execute a loyalty gator request', load the POST /api.php schema, and execute with request_type plus the form fields for that operation. Jentic builds the form body and adds the api_access_key header.

### Can I limit what my agent is allowed to do with the Loyalty Gator API?

Yes. The Loyalty Gator API routes every call through POST /api.php, with the request_type form field selecting the operation, so in your self-hosted Jentic One instance your own rules decide which request types are in the allowed set. You might permit customer_info lookups and transaction_add while excluding reward_redeem, and any request_type outside that set is not callable by the agent. Jentic One also injects the api_access_key at execution time, so the agent can only exercise the operations you have explicitly allowed.