Connectors / Service / Vennersys

Vennersys

Vennersys

Vennersys is one of the leading suppliers in EPOS and ticketing solutions for the Leisure and Hospitality industries.

Overview

Vennersys is a cloud visitor attraction solution provider, digitizing visitor attraction ticketing and point of sale processes, reducing queues, and improving customer service.

Authentication

Within the workflow builder, highlight the Vennersys connector.

In the Vennersys connector properties panel to the right of the builder, click on the Authenticate tab and the 'New authentication' button. This will result in a Tray.io authentication pop-up modal.

Name the authentication something that will easily identify it in a larger list. For example using the name of the service account, whether it is a Sandbox or Production OAuth, etc.

When choosing between the type of authentication you wish to create ('Personal' or 'Organisational'), consider who and how many people will need access to it.

The second page asks you for your 'Client ID', 'Username', 'Password', and 'Base URL' credentials.

You can get these values for your account from Vennersys.

Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Vennersys which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Vennersys API documentation, to find the exact format that Vennersys will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

For example, say that the 'List transactions' operation did not exist in our Vennersys connector, and you wanted to use this endpoint. You would use the Vennersys API docs to find the relevant endpoint - which in this case is a GET request called: /GetTransactions.

The endpoint for this operation will be /GetTransactions. As you can see there are also some required query parameters.

The 'LocationID' will be specific to the customer. The 'DateTimeFrom' param should be inputted in YYYY-MM-DDThh:mm:ss format. Use the 'Page' and 'PageSize' params to view each page of results. (Note, to return only the total amount of results, enter 'Page' as '1' and 'PageSize' as '0').

The 'TransactionRef' param is also required, according to the API docs. To return a specific result, enter it's 'TransactionRef' value. To view a list of all results, enter the value as 'null'. (Note, that when using the connectors existing 'list' operations, this field can instead be left blank to return the full list of results). In this example, we will return the full list of results.

So if you know what your method, endpoint and details of your query parameters are, you can get the transactions information with the following settings:

Method: GET

Endpoint: /GetTransactions

Query Parameters:
Key: LocationID Value: X,
Key: DateTimeFrom Value: 2000-01-01T00:00:00,
Key: Page Value: 1,
Key: PageSize Value: 10,
Key: TransactionRef Value: null,

Body Type : none

Final outcome being: <base_url>/GetTransactions?LocationID=X&DateTimeFrom=2000-01-01T00:00:00&Page=1&PageSize=10&TransactionRef=null

PLEASE NOTE: For the 'List' operations, you may need to add '/DataExchange' as a prefix to the Raw HTTP endpoint, depending on your base URL. In this example, the endpoint value would then be '/DataExchange/GetTransactions'.

Example Usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the vennersys connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is a simple example of a way in which you could potentially use the Vennersys connector to loop through transactions, and then get each individual transaction from the list.

The steps will be as follows:

  1. Setup using a manual trigger and list all transactions.
  2. Loop through all the transactions from the previous step.
  3. Get details of individual transactions.

Your completed workflow should look similar to this:

1 - Setup Trigger

With your trigger in place (be it Manual, Scheduled, Callable etc)

2 - List and loop all the transactions

As a next step, add a Vennersys connector. Set the operation to 'List transactions'.

As you can see, 'Location ID', 'Date time from', 'Page', and 'Page size' fields are mandatory. Provide suitable values based on your needs for these fields.

Leave the 'Transaction ref' field empty, as we want to return a list of all results.

Feel free to re-name your steps as you go along to make things clearer for yourself and other users. The operation names themselves often suffice.

This step will retrieve a list of all transactions in your Vennersys account.

Next, search for the Loop connector within your connector panel, and drag it into your workflow as your next step. Set your operation to 'Loop List'.

The Loop connector allows you to iterate through a list of results. In this example, we will use it to iterate through the data found within the previous Vennersys connector step.

In order to specify the list you want to loop through, start by using the list mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

Grab the connector snake from the 'List' field. In the 'List transactions' step (with the tail end of the connector-snake), select Results from the list of output properties displayed. This will auto-populate a jsonpath within your list input field, and update the type selector to jsonpath.

For more clarification on the pathways you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.
CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

This step allows you to loop through each of the items returned in step 1's results array, one at a time.

3 - Get each transaction individually by ID

The last step is to add another Vennersys connector inside the loop connector itself.

Again, set the operation to 'List transactions'. Enter appropriate values for the mandatory fields as we did in the List transactions step.

For the 'Transaction ref' field, grab the connector snake and drag it to the previous Loop connector step. Select the TransRef property from the list of output properties.

This step allows you to get individual transaction using it's ID, one at a time.

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our Managing data best practices guide.