Developer Hub

Welcome to the Synerise developer hub. Add extraordinary value to Your business with a Synerise integration, webhooks, API or customize Synerise for Your organization.

Get Started

API and SDK

API

Full Synerise API documentation is located under Reference

SDK

Synerise SDKs are publicly available on our official GitHub account

Webhooks

In addition to the above you can also utilize webhooks to notify other apps about changes in Synerise such as: client create or update and coupons add, update, use.
Go to Settings > Integrations > Webhooks and click Edit right to Webhook.

Choose event and past the URL where Synerise will try to sent webhooks about changes and set sending method. You can add as many web hooks as you want.

Synerise Platform (v4.3.0)

License: Proprietary

Overview

Welcome to Synerise API reference! We hope that you'll enjoy your stay here. If you need help with our services, feel free to contact us:

To open Synerise's collection in Postman, click:

Remember that every API call needs to have these headers defined:

Header name
Header value

Accept

application/json

Content-Type

application/json

Api-Version

4.3

Authorization

Bearer token

API Areas

We have following groups of endpoints that you can use:

API area
Description

Used for logging in and account management

Used for creating, updating and finding clients

Used for finding events and creating custom ones

Used for creating, updating and finding transactions

Used for Promotions

Used for Vouchers

Authorization

Synerise uses JSON Web Token (JWT) as the authorization method.

The token is generated by the auth/login endpoint. You need to include it in the Authorization header of your requests, with a Bearer prefix. See this simplified example of a call:

curl -X GET \
  https://api.rc.snrstage.com/v4/clients \
  -H 'Accept: application/json' \
  -H 'Api-Version: 4.3' \
  -H 'Authorization: Bearer eyJhbGc[...]BrVROhUTugG4IJMC2PZtLeefKcbER4I-UOuyYzG5Fb8A' \
  -H 'Content-Type: application/json' \

Remember to include a space between Bearer and the token.

The token is valid for one hour. You can request a refreshed key for the session by using the Refresh token endpoints before the current token expires.

You can verify your JWT token signature by using the public key.

Synerise API Consumer Types

Synerise defines two different types of API consumers:

Client

This is the end user of your website or application - the one who browses pages, purchases items, and so on. The Client can register and maintain their own account. They can also perform other customer actions, such as redeeming vouchers.

The Client can access and modify only their own data.

Business Profile

The Business Profile is assigned to a particular company. This consumer can use methods that, for example, create client accounts, record client actions, or manage promotions.

Synerise SDK

Our SDK enables integration of Synerise with your app. This constantly updated tool is dedicated to mobile platforms and back-end environments. Use Synerise SDK and feel free to use available documentation, headers for certain programming languages, example source codes.

API and SDK


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.