canonical: https://jentic.com/apis/5starsreputation.com.au/5starsreputation

# 5 Stars Reputation API

Jentic publishes the only available OpenAPI specification for 5 Stars Reputation API, keeping it validated and agent-ready. The 5 Stars Reputation API is the integration interface for the 5 Stars Reputation review and reputation management platform, exposing three POST endpoints that register customer locations, push existing reviews into a 5 Stars Reputation account, and import contacts that should be invited to leave a review. The API is intended for businesses syncing point-of-sale or CRM data so that 5 Stars Reputation can run review-request campaigns automatically. Authentication uses an API key supplied in the request body or header.

## For AI agents

Push customer locations, existing reviews, and contact lists into the 5 Stars Reputation platform so it can run review-request automations. Useful for agents wiring POS or CRM data into reputation workflows.

## Scope

Does not handle review-request email or SMS sending, response moderation, or campaign reporting - use only to push locations, reviews, and contacts into the 5 Stars Reputation platform.

## Capabilities

- Register a customer-facing location so review requests can be scoped to it
- Import existing reviews from another platform into 5 Stars Reputation for unified reporting
- Push contacts that should receive a review-request invitation
- Hand off freshly served customers from a CRM or POS to the reputation campaign engine

## Use cases

### Automate Review Requests After a Sale

Retailers and service businesses wire their point-of-sale or CRM into 5 Stars Reputation so customers receive a review-request invitation shortly after purchase. The /integrationapi/importcontact endpoint accepts contact details and tags them for the appropriate location, replacing manual CSV uploads. End-to-end automation typically takes half a day to wire from a POS webhook.

Example prompt: Call POST /integrationapi/importcontact with the customer's name, email, phone, and the location ID for the store they purchased from.

### Multi-Location Review Reporting

Multi-branch businesses register each location through /integrationapi/location and import existing reviews via /integrationapi/importreview so the 5 Stars Reputation dashboard reports across all branches in one place. This replaces per-location spreadsheet aggregation and gives leadership a single view of reputation. Initial setup runs about a day for ten to twenty locations.

Example prompt: For each branch, call POST /integrationapi/location with the address and operating hours, then POST /integrationapi/importreview to load that branch's existing reviews.

### CRM-Driven Review Campaigns via Jentic

An AI assistant connected through Jentic can listen for new closed-won deals or completed services and call 5 Stars Reputation to enroll those customers in a review-request flow. Jentic stores the API key in the vault and exposes the importcontact operation by intent, so the agent never needs to read the developer docs or hard-code endpoint paths. End-to-end response time is a few seconds per customer.

Example prompt: Search Jentic for 'invite a customer to leave a review', load /integrationapi/importcontact, and execute it with the new customer's contact details and assigned location.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /integrationapi/location | Register a customer-facing location |
| POST | /integrationapi/importreview | Import an existing review into 5 Stars Reputation |
| POST | /integrationapi/importcontact | Import a contact to be invited for a review |

## Key resources

- **Locations** — Business locations that scope reviews and contacts
- **Reviews** — Existing reviews imported from third-party platforms
- **Contacts** — Customers queued for review-request invitations

## Why Jentic

- **Setup:** Wiring the 5 Stars Reputation API by hand means managing its API key and shaping location, review, and contact import payloads yourself. Through Jentic you install once, import the 5 Stars Reputation API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** This API carries locations, reviews, and contacts in the request body rather than a resource id in the path, so limit the agent to the operations it needs, such as importing a contact, and leave out pushing locations or reviews unless you add them. You choose the allowed set, so only the operations you pick can run.
- **Credential handling:** Your 5 Stars Reputation 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 'import a review' or 'push a contact into 5 Stars Reputation', and Jentic returns the matching 5 Stars Reputation operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Yotpo UGC API** — Reviews and user-generated content platform with a broader ecosystem
- **Reply Reviews API** — Reputation platform focused on automated review responses
- **ReviewStudio API** — Review collection and management platform with media review workflows
- **HubSpot CRM Contacts API** — CRM contact source that often feeds review-request automations

## FAQ

### Why is there no official OpenAPI spec for 5 Stars Reputation API?

5 Stars Reputation publishes HTML integration documentation but does not distribute a machine-readable OpenAPI specification. Jentic generates and maintains this spec so AI agents and developers can call 5 Stars Reputation through structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the 5 Stars Reputation API use?

The API uses an API key issued from the 5 Stars Reputation account dashboard. The key is supplied on each request to /integrationapi endpoints. When called through Jentic the key is stored encrypted in the vault and attached at execution time, so it never appears in the agent's prompt.

### Can I import existing Google or Facebook reviews into 5 Stars Reputation through this API?

Yes. Call POST /integrationapi/importreview for each review, supplying the source, rating, reviewer name, and timestamp. The platform then includes those reviews in its dashboards and aggregate scoring.

### What are the rate limits for the 5 Stars Reputation API?

5 Stars Reputation does not publish a numeric rate limit. Treat the API as fair-use, batch contact imports where possible, and back off on HTTP 429 or 5xx responses. For nightly POS sync, schedule one batched run per location rather than per-customer calls.

### How do I enroll a customer for a review request through Jentic?

After running pip install jentic and setting JENTIC_AGENT_API_KEY, search Jentic for 'invite a customer to leave a review', load /integrationapi/importcontact, and execute it with the customer's contact details and the location ID. Jentic injects the API key automatically.

### Does the 5 Stars Reputation API send the review-request emails directly?

No. The API only ingests data - locations, reviews, and contacts. The 5 Stars Reputation platform handles the actual email and SMS review invitations using the campaign rules configured in its dashboard.

### Can I limit what my agent is allowed to do with the 5 Stars Reputation API?

Yes. Because you run Jentic One yourself, your own rules decide which of this API's three operations your agent can call: registering a location, importing a review, or importing a contact. Since each operation carries its data in the request body rather than a resource ID in the path, you scope by choosing the allowed operations, so you can permit only importing a contact and leave out pushing locations or reviews. Your agent can then run just the operations you selected, using the credentials you store, and nothing else.
