Quickstart guide

Send your first reward event

Three steps to go from a fresh Solary account to your first shopper earning points: get an API key, pick how you'll integrate, and send an event.

1. Get your API key

Every company on Solary has one active API key, generated from the Solary portal under Settings, API Keys. It's sent as the X-API-Key header on every request and identifies your company, so keep it server-side.

2. Pick how you'll integrate

You have two options, and you can mix both:

  • Install a ready-made plugin for Shopify, WooCommerce, or Magento and configure it with your API key and which events to track.
  • Call the events API directly from your own backend using one of the server SDKs (Node.js, PHP, Go, Python), or plain HTTP requests.

3. Send your first event

Every integration boils down to a single call: POST /events/create with your API key and the shopper's email. If no Solary user exists yet for that email, one is created automatically and linked to your company.

curl -X POST https://portal.solary.app/api/v1/events/create \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "eventType": "purchase_completed",
    "email": "shopper@example.com",
    "pointsEarned": 2000
  }'

Where do the points go?

Open the Solary portal and search for the shopper's email under Users. Their points balance updates immediately, and the transaction shows up with source external_api.

Next steps

Server SDKs