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 duration
• people=2 — optional — specify the number of involved stations
• experience=1 — optional — specify the experience type id

Note — there are no HTTPS POST parameters for the “delete” action.

The post Delete or Update Session Through API appeared first on Synthesis VR.

• 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 request like this:

• https://api.synthesisvr.com/data/giftcard/<KEY>/generate/<AMOUNT>/<EXPIRE_PERIOD>

Example:

• https://api.synthesisvr.com/data/giftcard/11111111-1111-1111-1111-111111111111/generate/15.50/2 months

Response data:

• {
"code": "REO6CUWR",
"valid": "2018-02-22T00:00:00",
"amount": 15.50,
"status": 1
}

 
Delete an unused Gift Card:
3. Construct an HTTP GET request:

• https://api.synthesisvr.com/data/giftcard/<KEY>/delete/<CODE>

Example:

• https://api.synthesisvr.com/data/giftcard/11111111-1111-1111-1111-111111111111/delete/REO6CUWR

The post Synthesis VR API – Gift Cards appeared first on Synthesis VR.

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 be able to access the collected data ONLY from an IP address associated with your location.

3. Prepare the following URL:

• https://api.synthesisvr.com/data/survey/<API_KEY>/<START_DATE>/<RATINGS>

Example:

• https://api.synthesisvr.com/data/survey/11111111-1111-1111-1111-111111111111/2019-06-01/4,5

Upon refreshing the Widgets page, you’ll be able to locate your API key:

 
START_DATE — use the YYYY-MM-DD format. The results you’ll get would be related only for surveys filled from the given data onward
RATINGS — comma-separated list of the rating results you would like to receive. This allows filtering out the negative ratings.
 

Extracting Survey data based on date:
. Prepare the following URL:

• https://api.synthesisvr.com/data/survey/bydate/<API_KEY>/<START_DATE>/<RANGE>

Example:

• https://api.synthesisvr.com/data/survey/bydate/11111111-1111-1111-1111-111111111111/2019-06-01/1%20year

The post Reading Survey Data Through API appeared first on Synthesis VR.

The post Synthesis VR API – Local API appeared first on Synthesis VR.

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 APIs, the client-side application calls (consumes) the server-side application. Whereas, in the case of webhooks it is the server-side that calls (consumes) the webhook (the end-point URL provided by the client-side application), i.e. it is the server-side application that calls the client-side application.

Webhooks operate on the concept of “event reaction” (don’t call me, I’ll call you if I have something new), and thus avoids the need for constant polling of the server-side application by the client-side application. Thus, rather than the client-side application constantly polling the server-side application to check for new events, the server-side application calls the client-side application (by invoking a client provided webhook URL) anytime the server-side has something new to report to the client.

Webhooks and SynthesisVR

The webhooks support is the only allowed way to receive events from Synthesis “as they happen”.
The Webhook configuration can be found under:

• Administration >> Advanced Settings –> the “Online & Email Settings” dropdown >> Web Widgets & API –> the “API & Webhooks” tab.

All events are HTTP POSTed to the related webhook URL. The URL must start either with http:// or https:// (preferred).

Your webhook handler has to respond within 2 seconds and the response is ignored by Synthesis. Synthesis won’t attempt resending the webhook if your webhook endpoint isn’t reachable.

All webhook events consist of JSON data.
One HTTP POST message may contain an array of multiple webhooks.
 

JSON SCHEMES:

SESSION WEBHOOK

• uuid — the Synthesis session id. It can be used for obtaining more information through the sessions API (https://synthesisvr.com/knowledge-base/reading-session-data-through-api/ — use the uuid: search option)
• action — possible values:
  • create – upon creation of the session
  • delete – upon removal of the session
• location — contains your location title. If you need to distinguish between multiple locations, you better configure unique webhook URLs rather than rely on the location title. It is included just your webhook reading experience more pleasant
• stations — provides the number of stations in session
• customerid — the ID of your customer. The full customer profile can be fetched through the customers API (https://synthesisvr.com/knowledge-base/reading-customers-data-through-api/ — use the id value as a search parameter)

 
Examples:

• [{“uuid”: “41509791-3de8-5bb9-b4fc-a9753da95aad”, “action”: “create”, “location”: “Kamen Test”, “stations”: 1, “customerid”: 7685}]
• [{“uuid”: “41509791-3de8-5bb9-b4fc-a9753da95aad”, “action”: “delete”, “location”: “Kamen Test”, “stations”: 1, “customerid”: 7685}]

More webhook options will come as the need of them emerge. If you have any specific request. please let us know: info@synthesisvr.com

The post Webhooks appeared first on Synthesis VR.

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 to open the widget page, copy all the source code in your own site and start editing the HTML / Javascript.
However, this still may not be sufficient for some of you, so here comes the direct API integration. If you are not a developer and you don’t have such on hand, please stick to the widget. The next would just confuse you unnecessary.

API CALL – AVAILABILITY

URL = https://api.synthesisvr.com/ Method = GET
Resource = /web/<public_key>/availability

Accepted parameters:

JSON Response:

Experience Type Object:
 

 
Availability Object:
 

API CALL – VALIDATE EMAIL

URL = https://api.synthesisvr.com/ Method = POST
Resource = /web/<public_key>/customers/validateEmail Accepted parameters:

JSON Response:

API CALL – CUSTOMER AUTHENTICATION

 
 
URL = https://api.synthesisvr.com/ Method = POST
Resource = /web/<public_key>/customers/auth

Accepted parameters:

JSON Response:

API CALL – CUSTOMER CREATION

URL = https://api.synthesisvr.com/ Method = POST
Resource = /web/<public_key>/customers/create

Accepted parameters:

The API response is the same JSON as for:

• /web/<public_key>/customers/auth

API CALL – CUSTOMER UPDATE CC

 
 
URL = https://api.synthesisvr.com/ Method = POST
Resource = /web/<public_key>/customers/updateCC Accepted parameters:

JSON Response:

PayPal Here – JSON object:
 

API CALL – CUSTOMER ASSIGN VOUCHER

URL = https://api.synthesisvr.com/ Method = POST
Resource = /web/<public_key>/customers/assignVoucher Accepted parameters:

JSON Response:

API CALL – RESERVATION BOOKING

URL = https://api.synthesisvr.com/ Method = POST
Resource = /web/<public_key>/book Accepted parameters:

JSON Response:

The post Synthesis VR API – Booking Widget appeared first on Synthesis VR.

• 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 custom waiver fields by going to “Administration” and click on your arcade name. Switch to the “Advanced” tab and click on “Additional Waiver Fields”.
If you need deeper customization for the online waiver, you can open the URL constructed above and use the browser’s “View Source” option. Copy the source code onto your server/web site and use HTML and CSS to customize the waiver widget.

The OFFLINE version is intended for use only inside your location. It allows the browser to load and process the waiver even when your device is completely offline. All signed forms will be stored inside the browser and will be synchronized to SynthesisVR within a minute of your device getting back online and the offline waiver page being reloaded.

The post Online Waivers appeared first on Synthesis VR.

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
TYPE = json OR xlsx
RANGE = indicates how many days should be returned after the main date (which can be set through the search criteria). The range value consist of an integer value (1) and a period string (hour ; day ; month ; year). Combinations are possible as well:

• 1 month 5 days
• 2 months 3 days
• 1 day 8 hours

SEARCH CRITERIA = a space separated string. Support the following options:

• date=[YYYY-MM-DD] — specifies the start date for the RANGE value (mandatory in the common case)
• date>[YYYY-MM-DD] — equal or great than the specified date
• date<[YYYY-MM-DD] — equal or less than the specified date
• crdate=[YYYY-MM-DD] — search by creation date
• today — considers the current date
• upcoming — any reservation that isn’t yet used
• skip_api — ignore all sessions created through the API (i.e. skip all sessions booked online)
• api_only — return only the online session
• customer:[ID] — obtain results for a specific customer account
• label:[ID] — obtain results based on a label(tag) ID
• uuid:[UUID] — lookup a specific session by its SynthesisVR Session ID
• externaluuid:[UUID] — lookup one or more sessions by an external UUID (supplied to Synthesis at creation time)
• [free text] — can be used to search based on customer name, email address, phone number and other specific information. It doesn’t require a prefix as with the options above.
• comments — extract the comments data (only for JSON exports)
• phone — include the customer phone number to the export

Note: Anything described above as [something] have to be replaced with the actual value you are looking for.

The post Reading Sessions & Goods Data Through API appeared first on Synthesis VR.

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 and backends.
To obtain the JSON data, prepare the following URL:

• (HTTP GET) https://api.synthesisvr.com/data/customers/<API_KEY>/json

Example:

• https://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/json

————————

JSON SEARCH:
To obtain the JSON data, prepare the following URL:

• (HTTP GET) https://api.synthesisvr.com/data/customers/<API_KEY>/search/<SEARCH>

Example:

• https://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/search/email@domain.com

————————

CSV:
As long the JSON provides all the customer information, the CSV can be formatted to a file, ready for manual important into a third party systems (e.g. email lists).
The request URL will be of the type:

• (HTTP GET) https://api.synthesisvr.com/data/customers/<API_KEY>/csv/<PARAMETERS>

Example:

• https://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/csv/fullname,email,phone

The output file will be ordered according to your web request.

Possible parameters:

• id = the Synthesis account id
• email = customer’s email address in lowercase
• fullname = capitalized customer’s name
• phone = self explanatory
• balance = any customer balance held by Synthesis
• widget = the widget used by the customer to subscribe
• sessions = the number of sessions for the current customer (combines previous and upcoming)
• regdate < or = or >  = extract customers based on date of registration. The date format is YYYY-MM-DD
• [ANY custom field] = the identifier of the custom fields defined for the location

To request more parameters, please shoot us an email to info@synthesisvr.com

————————

Profile Update (2022-11-18):

You can update customer profiles by performing HTTP POST request against the following URL:

• (HTTP POST) https://api.synthesisvr.com/data/customers/<API_KEY>/<CUSTOMER_ID>

All the new data should be in JSON format. The final JSON object is stringified and included in the request’s BODY with the “values” parameter.

Example raw HTTP POST request:

POST /data/customers/11111111-1111-1111-1111-111111111111/123456789 HTTP/1.1
Host: api.synthesisvr.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 43

values=%7B%22language%22%3A%22english%22%7D

You can include as many JSON key-value pairs as needed.

The post Reading Customers Data Through API appeared first on Synthesis VR.

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 be able to access the collected data ONLY from an IP address associated with your location.

3. Prepare the following URL:

• https://api.synthesisvr.com/data/leaderboard/<API_KEY>/<GAME_ID>/<DURATION>

Example:

• https://api.synthesisvr.com/data/leaderboard/11111111-1111-1111-1111-111111111111/15/6 month

Upon refreshing the Widgets page, you’ll be able to locate your API key:

 
Game ID — keep it to 0 (zero) if you want to fetch information about all the collected games. Based on that response, you’ll be able to see and use specific game ids
Duration — any combination of <number> + <period>. Examples:

• 5 days
• 17 days
• 117 days
• 2 months
• 2 months 13 days
• 7 months 2 days
• 1 year

The API response data is formatted as JSON and have the following structure:

 
The “score” object itself contains:

info = raw data extracted from the game (differ between the games)
score = SVR attempt to recognize and extract the score from the info object
customer = the customer associated with the SynthesisVR session. In a multi-station session, the data don’t necessary correlate with the actual player.
utcepoch = the UTC epoch when the leaderboard record is logged (you can look up the exact date/time in any programming language ; online example: https://www.epochconverter.com/)
 

The post Reading Leaderboard Through API appeared first on Synthesis VR.