Skip to content
RippleCore Help
Browse topics
Developers

RippleCore API

A RESTful API over HTTPS with JSON payloads and WebSocket support for live counters. The base URL is https://api.ripplecore.co.uk. Everything below is illustrative — there's no live backend yet.

Authentication

RippleCore uses JWT access tokens (15 min) plus refresh tokens (30 days) in HttpOnly cookies. Send Authorization: Bearer {accessToken} on every request; on a 401, call POST /auth/refresh.

Log an act — cURL
curl -X POST https://api.ripplecore.co.uk/acts \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "actType": "story",
    "caption": "Beach cleanup at Bunche Beach before class.",
    "category": "Environment",
    "locationPrecision": "city",
    "peopleHelped": 8
  }'

Acts

Create and read acts. Quick acts are private to their author and are never returned in shared feed queries; story acts post to the Circle's feed and can carry a location.

Reactions

Love and inspired reactions, follows, and ripple chains. Reaction writes are idempotent — posting the same reaction twice toggles it off.

Vouchers

Sponsor-backed reward vouchers. Redeeming marks a voucher as claimed and stamps it with the date; vouchers are single-use and tied to their owner.

POST
/acts

Log a new act (story or quick). Quick acts are never returned in shared feed queries.

GET
/feed?tab=all

The activity feed. Excludes other users' quick acts.

POST
/acts/{id}/reactions

Add a love or inspired reaction. Idempotent — toggles if already reacted.

POST
/follows

Follow a user. DELETE /follows/{id} to unfollow.

POST
/ripple-chains

Link a new act to the act that inspired it.

PATCH
/vouchers/{id}/redeem

Mark a reward voucher as claimed. Requires the owner to be logged in.

DELETE
/follows/{id}

Unfollow a user you previously followed.

Embed widget

Drop a live, read-only kindness widget on any website. Configure what it shows from the admin dashboard, then paste the snippet.

Embed snippet — HTML
<iframe
  src="https://ripplecore.com/embed/fgcu-eagles"
  width="100%" height="420"
  style="border:0;border-radius:16px"
  title="FGCU Eagles · Kindness"
></iframe>