ReferralCandy API
47
AI ReadinessFoundational (D)47/100
Official vendor OpenAPI document · agent-readyE CommerceStorefrontapiKey13 EndpointsREST
For Agents
Programmatically verify authentication credentials, retrieve list of campaigns. Covers 13 operations with apiKey authentication.
Use for: I need to verify authentication credentials, I want to list of campaigns, Search for register a new purchase, Find all query for referred purchases
Not supported: Does not handle payments, communications, or crm - use for e-commerce only.
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.
Install Jentic One Beta
Connect the ReferralCandy API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ReferralCandy API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Freferralcandy.com%2Freferralcandy" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Freferralcandy.com%2Freferralcandy" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with ReferralCandy API.
Verify authentication credentials
Retrieve list of campaigns
Register a new purchase
Query for referred purchases
Update purchase status
Use Cases
Patterns agents use ReferralCandy API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'verify authentication credentials', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
13 endpoints — referralcandy grows your brand with referral & affiliate programs.
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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
R
ReferralCandy API
- Foundational (D)47/100
93
Foundational Compliance63
Developer Experience & Jentic Compatibility46
AI-Readiness & Agent Experience94
Agent Usability15
Security71
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
93
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
1%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
46
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
31%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
52%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
15
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
15%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
71
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A-Signals: 1
71%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe
Alternative e commerce API
Choose Stripe when you need a different approach to e commerce operations
FAQs
Specific to using ReferralCandy API through Jentic.
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.
GET STARTED