Delete or Update Session Through API
Create a new API rule (similarly to https://synthesisvr.com/knowledge-base/reading-leaderboard-through-api/) or edit an existing one and assign the “customers” permission. HTTPS POST Request: https://api.synthesisvr.com/data/sessions/<API_KEY>/<ACTION>/<SESSION_UUID> Example: https://api.synthesisvr.com/data/sessions/11111111-1111-1111-1111-111111111111/update/22222222-2222-2222-2222-222222222222 https://api.synthesisvr.com/data/sessions/11111111-1111-1111-1111-111111111111/delete/22222222-2222-2222-2222-222222222222 ACTION= update OR delete Update HTTPS POST PARAMETERS: date=2030-01-01 — mandatory — specify new date for the session time=15:30 — mandatory — specify new time duration=60 — optional — specify new […]
Synthesis VR API – Gift Cards
1. Create a new API rule (similarly to https://synthesisvr.com/knowledge-base/reading-leaderboard-through-api/) or edit an existing one and assign the following permission: Gift Cards Important — SynthesisVR RECOMMEND using the “Strict Access” option and limit the endpoint access to your trusted IP addresses. Generate new Gift Card: 2. Get the key for the rule and construct an HTTP GET […]
Reading Survey Data Through API
To programmatically read the Survey data collected by SynthesisVR, please follow the steps: 1. Login into SynthesisVR with your administrator account and navigate to: 2. Click on the API & Webhooks tab and then click on the + sign in the top right: Make sure the Survey permission is assigned.If the “Strict Access” option is enabled, you will […]
Synthesis VR API – Local API
The local API is a special URL that runs on every of your VR stations and can be used for building third-party services and functionalities. The API URL is: http://localhost:8080/control/<API_COMMAND> Commands: Command Description status Provides a way to check the if SynthesisVR is running well. It should contain “status”:1 in the response status/hmd Represents […]
Webhooks
What is Webhook? Webhooks are an incredibly useful and resource-light way to implement event reactions. Webhooks provide a mechanism whereby a server-side application can notify a client-side application when a new event (that the client-side application might be interested in) has occurred on the server. Webhooks are also sometimes referred to as “Reverse APIs”. In […]
Synthesis VR API – Booking Widget
API As explained, the booking widget just utilizes the API and gives a ready to use example. However, in many cases, that may not be enough and as you may want to better match your website design, integrate your own payment processor, use a different language and so on. What usually would be enough is […]
Online Waivers
1. Create a new API rule (similarly to https://synthesisvr.com/knowledge-base/reading-leaderboard-through-api/) or edit an existing one and assign the following two permissions: Online Waiver Website Games 2. Get the key for the rule and construct an URL like this: Version 1: https://api.synthesisvr.com/waiver/<KEY> Version 2: https://api.synthesisvr.com/waiver/group/<KEY> Example: Version 1: https://api.synthesisvr.com/waiver/11111111-1111-1111-1111-111111111111 Version 2: https://api.synthesisvr.com/waiver/group/11111111-1111-1111-1111-111111111111 Version 2 OFFLINE: https://api.synthesisvr.com/waiver/offline/11111111-1111-1111-1111-111111111111 You can add […]
Reading Sessions & Goods Data Through API
1. Create a new API rule (similarly to https://synthesisvr.com/knowledge-base/reading-leaderboard-through-api/) or edit an existing one and assign the “customers” permission. 2. The customers data is available in both – JSON and XLSX formats. HTTP GET Request: The result is suitable for automation in third party tools and backends. https://api.synthesisvr.com/data/<ENDPOINT>/<API_KEY>/<TYPE>/<RANGE>/<SEARCH CRITERIA> Example: https://api.synthesisvr.com/data/sessions/11111111-1111-1111-1111-111111111111/json/1 day/date=2019-07-12 ENDPOINT = sessions OR goods […]
Reading Customers Data Through API
1. Create a new API rule (similarly to https://synthesisvr.com/knowledge-base/reading-leaderboard-through-api/) or edit an existing one and assign the “customers” permission. 2. The customers data is available in both – JSON and CSV (comma separated) formats. 3. You can call search queries and fetch JSON results ———————— JSON: The result is suitable for automation in third party tools […]
Reading Leaderboard Through API
To programatically read the leaderboard data collected by SynthesisVR, please follow the steps: 1. Login into SynthesisVR with your administrator account and navigate to: 2. Head to the API & Webhooks tab and click on the + button on the top right: Make sure the leaderboard permission is assigned.If the “Strict Access” option is enabled, you will […]