The Synerise AI Developer Hub

Welcome to the Synerise AI developer hub. You'll find comprehensive guides and documentation to help you start working with Synerise AI API as quickly as possible, as well as support if you get stuck.
Let's jump right in!

Quick start with Synerise AI API

This page will help you get started with syneriseai. You'll be up and running in a jiffy!

In order to start using Synerise AI API you need to get your API key and Secret Key. Your Business Profile API keys are available in Settings > Edit profile section.

The first step to use Synerise AI API is to perform authorisation using Auth API

import requests

auth_login_url = "https://ai-api.synerise.com/auth/v1/login/profile"

request_json = {
"apiKey": "API KEY",
"secretKey": "SECRET KEY"
}

headers = {
  'Content-Type': 'application/json'
}

response = requests.post(auth_login_url, json=request_json, headers=headers)

token = response.json()['token']
print 'Authorization token: ', token

You should now either integrate Synerise AI tracker or start providing events using Events API

Assuming that you already integrated Synerise AI tracker, we can try to fetch statistics of events that you've provided. To do that we're going to use Stats API

First we're going to check whether API is healthy and whether this service is already enabled for your profile.

stats_health_url = "https://ai-api.synerise.com/stats/v1/healthcheck"
stats_status_url = "https://ai-api.synerise.com/stats/v1/status"

headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer ' + token  # we need to use token now
}

response = requests.get(stats_health_url, headers=headers)
assert response.text == 'OK'

response = requests.get(stats_status_url, headers=headers)
print response.text
# And we're hoping to see following response:
# {
#   "enabled": true, 
#   "message": "OK", 
#   "ready": false
# }

If everything is fine, we may actually fetch some data:

stats_events_url = "https://ai-api.synerise.com/stats/v1/events"

headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer ' + token  # we need to use token now
}

response = requests.get(stats_events_url, headers=headers)
print response.json()

This concludes this short introduction to Synerise AI API.


Quick start with Synerise AI API


This page will help you get started with syneriseai. You'll be up and running in a jiffy!

Suggested Edits are limited on API Reference Pages

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