التوثيق متاح حاليًا باللغة الإنجليزية فقط.

API and webhooks (Pro)

Everything is under Developers in the sidebar. The automation hook (inbound) is available on every plan and is described in *Collect more reviews*; the REST API and outgoing webhooks are part of the Pro plan.

REST API

Create a token, then:

GET https://app.admirly.com/api/v1/testimonials
Authorization: Bearer ak_…

Query parameters: status (approved by default; pending, archived, all), tag, min_rating, per_page (max 100), page. A single review: GET /api/v1/testimonials/{id}. Responses are JSON with data and meta; each item has the author, rating, text, language, tags, custom fields, photo and video URLs.

Tokens are shown once and can be revoked at any time. Limit: 120 requests per minute.

Outgoing webhooks

Add a public https:// URL and choose events: testimonial.created (a new review arrived) and testimonial.approved. We POST a JSON body:

{"event": "testimonial.approved", "space": "your-space", "created_at": "…", "data": { "id": 123, "author": { "name": "…" }, "rating": 5, "text": "…" }}

Verify the X-Admirly-Signature header: sha256= followed by the HMAC-SHA256 of the raw body with the secret shown when you created the webhook. Failed deliveries are retried twice (after 1 and 10 minutes) and listed on the page.

شيء غير واضح؟ أخبرنا.