canonical: https://jentic.com/apis/revi.io/revi

# Revi Reviews API

REST API for interacting with the Revi.io reviews platform. Manage orders, products, and reviews for your e-commerce shop. The API exposes 8 endpoints secured with apiKey authentication.

## For AI agents

Programmatically test connection, create orders. Covers 8 operations with apiKey authentication.

## Scope

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

## Capabilities

- Test connection
- Create orders
- Update status of orders
- Link products to orders
- Get product review info

## Use cases

### E-Commerce Operations

Use the Revi Reviews API to perform e commerce operations programmatically. The API provides 8 endpoints covering core functionality including test connection, create orders, update status of orders.

Example prompt: Call POST /hello_world to test connection

### Automated Quickstart Management

Automate quickstart operations by combining multiple Revi Reviews API endpoints. Agents can create orders and then update status of orders in a single workflow.

Example prompt: Call POST /orders to create orders, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Revi Reviews 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 'test connection', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/hello_world` | Test connection |
| POST | `/orders` | Create orders |
| POST | `/orders_status` | Update status of orders |
| POST | `/products` | Create products |
| POST | `/orders_products` | Link products to orders |
| GET | `/product_info` | Get product review info |
| GET | `/reviews` | Get reviews |
| GET | `/shop_info` | Get shop rating info |

## Key resources

- **Quickstart** — Connection testing
- **Orders** — Order management
- **Products** — Product management
- **Reviews** — Review retrieval
- **Shop** — Shop information

## 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:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 67 / 100
- **View full report:** https://jentic.com/apis/revi.io/revi/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 Revi Reviews API by hand means handling its X-API-KEY header auth, passing that key on every call to api.revi.io, and managing retries yourself. Through Jentic you install once, import the Revi Reviews API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Revi's targets travel in the request body and query rather than as a resource id you can pin, so limit the agent to the operations it needs, such as reading product info or listing reviews. You choose that set, so write operations like posting orders or products are not included unless you add them.
- **Credential handling:** Your Revi 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 'read shop info' or 'list product reviews', and Jentic returns the matching Revi Reviews 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 Revi Reviews API use?

The Revi Reviews API uses an API key passed in the `X-API-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 test connection with the Revi Reviews API?

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

### What are the rate limits for the Revi Reviews 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 test connection through Jentic?

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

### How many endpoints does the Revi Reviews API have?

The Revi Reviews API exposes 8 endpoints covering quickstart, orders, products operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Revi Reviews API operations and credentials the agent can use, and Revi's targets travel in the request body and query rather than as a resource id you can pin, so you scope access by operation. You can allow the agent only read calls such as GET /product_info, GET /reviews, and GET /shop_info, leaving write operations like POST /orders, POST /products, and POST /orders_status out unless you add them. The stored API key is injected at execution time for the operations you permit, so the agent cannot reach endpoints outside that set.