canonical: https://jentic.com/apis/referralcandy.com/referralcandy

# ReferralCandy API

ReferralCandy grows your brand with referral & affiliate programs. Ideal for eCommerce stores selling one-off & subscription products. The API exposes 13 endpoints secured with apiKey authentication.

## For AI agents

Programmatically verify authentication credentials, retrieve list of campaigns. Covers 13 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Verify authentication credentials
- Retrieve list of campaigns
- Register a new purchase
- Query for referred purchases
- Update purchase status

## Use cases

### E-Commerce Operations

Use the ReferralCandy API to perform e commerce operations programmatically. The API provides 13 endpoints covering core functionality including verify authentication credentials, retrieve list of campaigns, register a new purchase.

Example prompt: Call GET /verify.json to verify authentication credentials

### Automated Authentication Management

Automate authentication operations by combining multiple ReferralCandy API endpoints. Agents can retrieve list of campaigns and then register a new purchase in a single workflow.

Example prompt: Call GET /campaigns.json to retrieve list of campaigns, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call ReferralCandy API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'verify authentication credentials', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/verify.json` | Verify authentication credentials |
| GET | `/campaigns.json` | Retrieve list of campaigns |
| POST | `/purchase.json` | Register a new purchase |
| GET | `/referrals.json` | Query for referred purchases |
| POST | `/referral.json` | Update purchase status |
| GET | `/referrer.json` | Query for referrer |
| GET | `/contacts.json` | Query for contacts |
| POST | `/signup.json` | Add contact to system |

## Key resources

- **Authentication** — Authentication verification
- **Campaigns** — Campaign management
- **Purchases** — Purchase and referral tracking
- **Contacts** — Contact and advocate management
- **Rewards** — Reward management

## Why Jentic

- **Setup:** Wiring the ReferralCandy API by hand means appending your accessID key as a query parameter on every call and handling retries against the my.referralcandy.com host yourself. Through Jentic you install once, import the ReferralCandy API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The ReferralCandy API carries its details in the request body and query, with endpoints like purchase.json and signup.json, so scoping is by operation: limit the agent to the operations it needs, such as verifying credentials or recording a purchase, rather than to a single record. Every operation the agent can run is one you have chosen to allow.
- **Credential handling:** Your ReferralCandy API 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 'record a purchase' or 'sign up a referrer', and Jentic returns the matching ReferralCandy API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the ReferralCandy API use?

The ReferralCandy API uses an API key passed in the `accessID` query. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I verify authentication credentials with the ReferralCandy API?

Yes. Use the GET /verify.json endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ReferralCandy API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I verify authentication credentials through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'verify authentication credentials'. Jentic returns the matching ReferralCandy API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the ReferralCandy API have?

The ReferralCandy API exposes 13 endpoints covering authentication, campaigns, purchases operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which ReferralCandy operations and credentials your agent may use, and scoping here is by operation rather than by a single record. You can allow read-only calls like verifying credentials with GET /verify.json or listing campaigns with GET /campaigns.json while withholding write operations such as POST /purchase.json or POST /signup.json. Every operation the agent can run is one you have chosen to allow.