API reference

API reference

The full Solary REST API, covering events, users, rewards, and rules, documented as an interactive OpenAPI reference.

Interactive reference

The Solary API is built with NestJS and ships with an auto-generated OpenAPI document, served through Swagger UI at /docs on your API host. For most integrations you'll only ever need the events endpoint, but the full reference is useful for anything beyond event tracking, like reading a user's points balance or browsing the reward catalog.

url
https://portal.solary.app/api/docs

Enable it first

The interactive reference is gated behind the ENABLE_SWAGGER environment variable on the API and is off by default in production. Ask your Solary contact to enable it for your environment, or run it locally against your own deployment.

Authentication

The API supports two separate authentication modes, depending on who's calling it:

  • Integrations (your store, your backend) authenticate with the X-API-Key header. This is what the SDKs and platform plugins use, see the Events API.
  • Portal users (people logged into the Solary portal) authenticate with a bearer token. This covers everything else in the reference: managing users, rewards, and rules.

Base URL

EnvironmentBase URL
Productionhttps://portal.solary.app/api/v1
Local developmenthttp://localhost:4000/v1
Server SDKsEvents API