Virtuagym
With Virtuagym modules in Boost.space Integrator, you can monitor and modify both visits and members in your Virtuagym account.
To get started with Virtuagym, create an account at virtuagym.com.
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory.
Connect Virtuagym to Boost.space Integrator
To make a connection to Virtuagym you need your login credentials, an API Key, and Club credentials from Virtuagym support.
You must have a Professional/Business account to make a connection to Virtuagym.
-
Request an API Key from Virtuagym here. Check your email afterward and copy your new key.
-
Log in to your Virtuagym account. Make note of your login credentials for later.
-
Click System settings, then Business Info. Copy your Club ID to your clipboard.
-
Click Advanced, then copy your Club Key. This is the Club Secret you need later to complete the connection.
-
Go to your Boost.space Integrator scenario and choose the Virtuagym module you want to use.
-
Next to Connection, click Add.
-
Give your new connection a name.
-
Enter your Virtuagym email and password in their respective fields.
-
Enter the Club ID, Club Secret, and API Key in their respective fields.
-
Click Save.
You have successfully created a connection.
Triggers
Watch Members
Returns new or updated members.
Connection
Establish a connection to your Virtuagym account.
Limit
Select the maximum numbers of members Boost.space Integrator returns during one scenario execution cycle.
Watch Memberships
Returns new or updated membership instances since the last check.
Connection
Establish a connection to your Virtuagym account.
Limit
Select the maximum numbers of memberships Boost.space Integrator returns during one scenario execution cycle.
Watch Visits
Returns new visits (check-in actions of members in a club) since the last check.
Connection
Establish a connection to your Virtuagym account.
Limit
Select the maximum numbers of visits Boost.space Integrator returns during one scenario execution cycle.
Watch Members Credits
Returns newly updated credits since the last check.
Connection
Establish a connection to your Virtuagym account.
Limit
Select the maximum numbers of member credits Boost.space Integrator returns during one scenario execution cycle.
Watch Members (by ID)
Triggers when a new club member has been created/added.
Difference from Watch Members module is that this module uses only member IDs to detect new ones.
Connection
Establish a connection to your Virtuagym account.
Limit
Select the maximum numbers of members Boost.space Integrator returns during one scenario execution cycle.
Actions
Create a Member
Creates a new member.
Connection
Establish a connection to your Virtuagym account.
First Name
Enter the first name of the member.
Last Name
Enter the last name of the member.
Enter the email address of the member. An invitation will be sent to this address when the member is created.
Level
Select the level of the member.
-
Novice
-
Beginner
-
Intermediate
-
Advanced
-
Expert
Goal
Select the goal of the member.
-
Lose Weight
-
Build Muscle
-
Improve well-being
-
Improve Performance
-
Rehabilitation
-
Get Fit
-
Shape and Tone
These are the default names. They could be different per club.
Filled Intake Questionnaire
Select whether or not the member has filled in the mandatory intake questionnaire.
External ID
Enter the ID from the external system.
Active
Select whether the member is active or inactive.
Gender
Select the gender of the member.
-
Male
-
Female
Birthday
Enter the birthday of the member. See the list of supported date formats.
Portal Language
Select the language the member uses in the portal.
ZIP
Enter the zip code of the member.
Street
Enter the street address of the member.
Street Extra
Enter any extra street information of the member.
Place
Enter the place where the member lives.
Country
Select the country where the member lives.
Formatted Address
Enter a nicely formatted string of the street address of the member.
Phone
Enter the phone number of the member.
Mobile
Enter the mobile phone number of the member.
Bank Account Holder Name
Enter the bank account holder name.
Bank Account Number
Enter the bank account number.
Bank Account BIC Code
Enter the BIC code of the bank account.
Is Pro
Select whether or not the member is pro.
Unsubscribe Date
Enter the future inactive date of the member in YYYY-MM-DD format.
Update a Member
Updates a member by internal Virtuagym ID.
Connection
Establish a connection to your Virtuagym account.
Member
Select the ID of the member you want to update.
First Name
Enter the first name of the member.
Last Name
Enter the last name of the member.
Enter the email address of the member. An invitation will be sent to this address when the member is created.
Level
Select the level of the member.
-
Novice
-
Beginner
-
Intermediate
-
Advanced
-
Expert
Goal
Select the goal of the member.
-
Lose Weight
-
Build Muscle
-
Improve well-being
-
Improve Performance
-
Rehabilitation
-
Get Fit
-
Shape and Tone
These are the default names. They could be different per club.
Filled Intake Questionnaire
Select whether or not the member has filled in the mandatory intake questionnaire.
External ID
Enter the ID from the external system.
Active
Select whether the member is active or inactive.
Gender
Select the gender of the member.
-
Male
-
Female
Birthday
Enter the birthday of the member. See the list of supported date formats.
Portal Language
Select the language the member uses in the portal.
ZIP
Enter the zip code of the member.
Street
Enter the street address of the member.
Street Extra
Enter any extra street information of the member.
Place
Enter the place where the member lives.
Country
Select the country where the member lives.
Formatted Address
Enter a nicely formatted string of the street address of the member.
Phone
Enter the phone number of the member.
Mobile
Enter the mobile phone number of the member.
Bank Account Holder Name
Enter the bank account holder name.
Bank Account Number
Enter the bank account number.
Bank Account BIC Code
Enter the BIC code of the bank account.
Is Pro
Select whether or not the member is pro.
Unsubscribe Date
Enter the future inactive date of the member in YYYY-MM-DD format.
Update a Member by external ID
Updates a member by external system ID.
Connection
Establish a connection to your Virtuagym account.
External ID
Enter the ID of the member from the external system.
First Name
Enter the first name of the member.
Last Name
Enter the last name of the member.
Enter the email address of the member. An invitation will be sent to this address when the member is created.
Level
Select the level of the member.
-
Novice
-
Beginner
-
Intermediate
-
Advanced
-
Expert
Goal
Select the goal of the member.
-
Lose Weight
-
Build Muscle
-
Improve well-being
-
Improve Performance
-
Rehabilitation
-
Get Fit
-
Shape and Tone
These are the default names. They could be different per club.
Filled Intake Questionnaire
Select whether or not the member has filled in the mandatory intake questionnaire.
External ID
Enter the ID from the external system.
Active
Select whether the member is active or inactive.
Gender
Select the gender of the member.
-
Male
-
Female
Birthday
Enter the birthday of the member. See the list of supported date formats.
Portal Language
Select the language the member uses in the portal.
ZIP
Enter the zip code of the member.
Street
Enter the street address of the member.
Street Extra
Enter any extra street information of the member.
Place
Enter the place where the member lives.
Country
Select the country where the member lives.
Formatted Address
Enter a nicely formatted string of the street address of the member.
Phone
Enter the phone number of the member.
Mobile
Enter the mobile phone number of the member.
Bank Account Holder Name
Enter the bank account holder name.
Bank Account Number
Enter the bank account number.
Bank Account BIC Code
Enter the BIC code of the bank account.
Is Pro
Select whether or not the member is pro.
Unsubscribe Date
Enter the future inactive date of the member in YYYY-MM-DD format.
Create a Visit
Creates a visit.
Connection
Establish a connection to your Virtuagym account.
Member ID
Select the ID of the member as stored in Virtuagym triggering the check-in.
Either Member ID or RFID Tag must be passed.
RFID Tag
Enter the value of RFID tag as stored in Virtuagym. To ensure the correct value, refer to the Club Members API.
Either Member ID or RFID Tag must be passed.
Action
Select what the current visit corresponds. Default is Check in.
-
Check in
-
Check out
Status
Select the status of the visit.
-
Ok
-
Warning
-
Rejected
Status Message
Enter any supplementary text of the visit.
Get a Member
Retrieves a club member.
Connection
Establish a connection to your Virtuagym account.
Member
Select the ID of the member you want to retrieve.
Allocate Credits to a Member
Allocates a given amount of credits to a specified member.
Connection
Establish a connection to your Virtuagym account.
Service Type
Enter the type of service (e.g. access, solarium).
This field is lower case only.
Member ID
Select the ID of the member which checked in or out.
You must provide either this field or the Member Email.
Member Email
Enter the email address of the member to add the credits to.
You must provide either this field or the Member ID.
Credit Amount
Enter the amount of credits to add. Must be greater than 0.
You must provide either this field or the Credit Unlimited.
Credit Unlimited
Select whether to add unlimited credit. If Yes, unlimited credits are added to the user’s account if they don’t already have. If No, unlimited credits are removed if they already have.
You must provide either this field or the Credit Amount.
Valid Until
Enter the date till when the credits are valid. See the list of supported date formats.
Notes
Enter a description explaining why the credits are added (e.g. bought online).
Searches
List Members Credits
Returns a member credits list.
Connection
Establish a connection to your Virtuagym account.
Member ID
Select the ID of the member you want to list credits from.
Synchronized from
Enter where the member is synchronized from. This should be a timestamp in milliseconds.
Limit
Select the maximum numbers of credit lists Boost.space Integrator returns during one scenario execution cycle.
Search Members
Searches for members.
Connection
Establish a connection to your Virtuagym account.
Synchronized from
Enter where the members are synchronized from. See the list of supported date and time formats.
Returns all member of the club that have been edited since Synchronized From.
From ID
Enter the from ID of the member.
Club Member ID
Enter the club ID of the member.
With
Select which sub-resource applies to the member.
-
Memberships (Active & Inactive)
-
Active Memberships
Any Sub Club
Select wether the member belongs to any other clubs.
RFID Tag
Enter the RFID tag.
External ID
Enter the external ID of the member.
Enter the email address of the member.
Limit
Enter the maximum numbers of members Boost.space Integrator returns during one scenario execution cycle.
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/lifestyle/virtuagym/).