canonical: https://jentic.com/apis/swaggerhub.develop-beyable/beyable-ranking-api

# Develop Beyable BEYABLE Ranking API

Get product rankings in CSV format (comma separated, quoted strings) with 3 columns "ProductId", "abTestGroup" and "Position". The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically getproductrankingwithperso, getproductrankingnoperso. Covers 4 operations with apiKey authentication.

## Scope

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

## Capabilities

- GetProductRankingWithPerso
- GetProductRankingNoPerso
- Integrate BEYABLE Ranking API into automated workflows
- Query and filter BEYABLE Ranking API records by parameters
- Monitor BEYABLE Ranking API operational status and events

## Use cases

### E-Commerce Operations

Use the BEYABLE Ranking API to perform e commerce operations programmatically. The API provides 4 endpoints covering core functionality including getproductrankingwithperso, getproductrankingnoperso, getproductrankingwithpersodefaulttenant.

Example prompt: Call GET `/persoproductranking/{accountId}/{rankingGroupId}/{segmentId}/{tenant}` to getproductrankingwithperso

### Automated persoproductranking Management

Automate persoproductranking operations by combining multiple BEYABLE Ranking API endpoints. Agents can getproductrankingnoperso and then getproductrankingwithpersodefaulttenant in a single workflow.

Example prompt: Call GET `/productranking/{accountId}/{rankingId}/{tenant}` to getproductrankingnoperso, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call BEYABLE Ranking 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 'getproductrankingwithperso', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/persoproductranking/{accountId}/{rankingGroupId}/{segmentId}/{tenant}` | GetProductRankingWithPerso |
| GET | `/productranking/{accountId}/{rankingId}/{tenant}` | GetProductRankingNoPerso |
| GET | `/persoproductranking/{accountId}/{rankingGroupId}/{segmentId}` | GetProductRankingWithPersoDefaultTenant |
| GET | `/productranking/{accountId}/{rankingId}` | GetProductRankingNoPersoDefaultTenant |

## Key resources

- **persoproductranking** — Operations related to persoproductranking
- **productranking** — Operations related to productranking

## Why Jentic

- **Setup:** Wiring the BEYABLE Ranking API by hand means setting up its subscription-key API key (in a header or query), pointing at the apibeyableprod.azure-api.net host, and handling retries yourself. Through Jentic you install once, import the BEYABLE Ranking API from the API Directory, store the subscription key once, and your agent calls it.
- **Permission scoping:** The BEYABLE Ranking API puts the account and ranking ids in the URL path (`/productranking/{accountId}/{rankingId}`), so a rule can pin your agent to one account's rankings. All of its operations are read-only ranking lookups, and the agent only ever runs the ones you include.
- **Credential handling:** Your BEYABLE subscription 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 'get a product ranking for an account' or 'get a personalized ranking for a segment', and Jentic returns the matching BEYABLE Ranking 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 BEYABLE Ranking API use?

The BEYABLE Ranking API uses an API key passed in the `Subscription-key` 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 getproductrankingwithperso with the BEYABLE Ranking API?

Yes. Use the GET `/persoproductranking/{accountId}/{rankingGroupId}/{segmentId}/{tenant}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the BEYABLE Ranking 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 getproductrankingwithperso through Jentic?

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

### How many endpoints does the BEYABLE Ranking API have?

The BEYABLE Ranking API exposes 4 endpoints covering persoproductranking, productranking operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which of the four operations the agent may call, so you can allow only the read-only ranking lookups it needs, such as GET `/productranking/{accountId}/{rankingId}` or the personalized GET `/persoproductranking/{accountId}/{rankingGroupId}/{segmentId}/{tenant}.` Since the account and ranking ids sit in the URL path, a rule can pin the agent to one account's rankings and nothing else. Every operation is a read-only lookup, and the subscription key is injected at execution time rather than exposed to the agent.