canonical: https://jentic.com/apis/s15socialannex.net/s15socialannex

# S15socialannex Annex Cloud Loyalty API

Annex Cloud API v3.0 for loyalty program management including users, orders, points, rewards, segments, and campaigns. The API exposes 14 endpoints secured with apiKey, bearer authentication.

## For AI agents

Programmatically create a user and enroll in loyalty program, retrieve user profile details. Covers 14 operations with apiKey, bearer authentication.

## Scope

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

## Capabilities

- Create a user and enroll in loyalty program
- Retrieve user profile details
- Update user information
- Fetch user activity history with pagination
- Get current and next tier information

## Use cases

### Marketing Operations

Use the Annex Cloud Loyalty API to perform marketing operations programmatically. The API provides 14 endpoints covering core functionality including create a user and enroll in loyalty program, retrieve user profile details, update user information.

Example prompt: Call POST /users to create a user and enroll in loyalty program

### Automated Users Management

Automate users operations by combining multiple Annex Cloud Loyalty API endpoints. Agents can retrieve user profile details and then update user information in a single workflow.

Example prompt: Call GET `/users/{id}` to retrieve user profile details, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Annex Cloud Loyalty 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, bearer tokens manually.

Example prompt: Search Jentic for 'create a user and enroll in loyalty program', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/users` | Create a user and enroll in loyalty program |
| GET | `/users/{id}` | Retrieve user profile details |
| PATCH | `/users/{id}` | Update user information |
| GET | `/users/{id}/activity` | Fetch user activity history with pagination |
| GET | `/users/{id}/usedreward` | Retrieve redeemed rewards list |
| GET | `/users/{id}/tiers` | Get current and next tier information |
| GET | `/users/{id}/reward` | Retrieve available rewards for user |
| POST | `/orders` | Create a new order |

## Key resources

- **Users** — User management and loyalty enrollment
- **Orders** — Order creation and status management
- **Points** — Points balance, credits, debits, and redemptions
- **Rewards** — Available rewards for users
- **Segments** — Segment membership details

## 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:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 45 / 100
  - Agent Usability: 94 / 100
  - Security: 63 / 100
  - AI Discoverability: 63 / 100
- **View full report:** https://jentic.com/apis/s15socialannex.net/s15socialannex/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 Annex Cloud Loyalty API by hand means managing its API key and bearer token, attaching them to each call against s15.socialannex.net, and handling your own retries. Through Jentic you install once, import the Annex Cloud Loyalty API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Annex Cloud puts the user id in the URL path (`/users/{id}/...`), so a rule can pin your agent to one user: it can read that user's activity, tiers, and rewards and nothing else. You choose the operations it may call, so updating a user or placing an order is not included unless you add it.
- **Credential handling:** Your Annex Cloud Loyalty API credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'enroll a user in the loyalty program' or 'check a user's reward tier', and Jentic returns the matching Annex Cloud Loyalty API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### What authentication does the Annex Cloud Loyalty API use?

The Annex Cloud Loyalty API uses apiKey, bearer authentication. 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 a user and enroll in loyalty program with the Annex Cloud Loyalty API?

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

### What are the rate limits for the Annex Cloud Loyalty 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 a user and enroll in loyalty program through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a user and enroll in loyalty program'. Jentic returns the matching Annex Cloud Loyalty API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Annex Cloud Loyalty API have?

The Annex Cloud Loyalty API exposes 14 endpoints covering users, orders, points operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Annex Cloud operations and credentials the agent may use. Since Annex Cloud puts the user id in the URL path (`/users/{id}/...`), you can pin the agent to a single user and let it only read that user's activity, tiers, and rewards. Updating a user profile or placing an order stays out of reach unless you explicitly add those operations.