canonical: https://jentic.com/apis/referly.so/referly-so

# Referly So Referly API

Referly is a referral software that helps you create a referral program for your business in minutes. Manage affiliates, referrals, sales, coupons, promotional codes, and affiliate links. The API exposes 25 endpoints secured with bearer authentication.

## For AI agents

Programmatically create an affiliate, get affiliate(s). Covers 25 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Create an affiliate
- Get affiliate(s)
- Update an affiliate
- Delete an affiliate
- Monitor Referly API operational status and events

## Use cases

### Developer Tools Operations

Use the Referly API to perform developer tools operations programmatically. The API provides 25 endpoints covering core functionality including create an affiliate, get affiliate(s), update an affiliate.

Example prompt: Call POST /affiliates to create an affiliate

### Automated Affiliates Management

Automate affiliates operations by combining multiple Referly API endpoints. Agents can get affiliate(s) and then update an affiliate in a single workflow.

Example prompt: Call GET /affiliates to get affiliate(s), then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Referly 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 bearer tokens manually.

Example prompt: Search Jentic for 'create an affiliate', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/affiliates` | Create an affiliate |
| GET | `/affiliates` | Get affiliate(s) |
| PUT | `/affiliates` | Update an affiliate |
| DELETE | `/affiliates` | Delete an affiliate |
| POST | `/referrals` | Create a referral |
| GET | `/referrals` | Get referral(s) |
| PUT | `/referrals` | Update a referral |
| DELETE | `/referrals` | Delete a referral |

## Key resources

- **Affiliates** — Manage affiliates in your referral program
- **Referrals** — Manage referrals
- **Links** — Manage affiliate links
- **Coupons** — Manage coupons
- **PromotionalCodes** — Manage promotional codes

## AI readiness

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.

- **Score:** 70 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 56 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 74 / 100
- **View full report:** https://jentic.com/apis/referly.so/referly-so/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Referly API by hand means setting its bearer token on every request and building your own retry handling against the www.referly.so host. Through Jentic you install once, import the Referly API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The Referly API works on collection endpoints like /affiliates and /referrals with the target in the request body, so scoping is by operation: limit the agent to the operations it needs, such as creating or listing affiliates, rather than to a single record. Destructive operations like deleting an affiliate or a referral are only available if you include them.
- **Credential handling:** Your Referly API bearer token 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 'create an affiliate' or 'list referrals', and Jentic returns the matching Referly API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Referly API use?

The Referly API uses a Bearer token in the Authorization header. 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 create an affiliate with the Referly API?

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

### What are the rate limits for the Referly 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 create an affiliate through Jentic?

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

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

The Referly API exposes 25 endpoints covering affiliates, referrals, links operations.

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

Yes. Because you run Jentic One yourself and your own rules decide which operations and credentials the agent may use, you scope the Referly API by operation. The Referly API works on collection endpoints like /affiliates and /referrals with the target in the request body, so you grant only the operations the agent needs, such as creating or listing affiliates, and leave the rest out. Destructive operations like deleting an affiliate or a referral are available only if you explicitly include them.