My Document - Help Documents
Transcription
My Document - Help Documents
MYiCLUBonline API User Guide Contents Introduction Revisions to this Document 3 3 MYiCLUBonline URLs 4 Unbranded Version 4 Branded Version 4 Class List 4 Linked Class List 4 Embedded Class List 5 Class Searches 5 Example Trainer Search 5 Example Room Search 5 Example Class Name Search 5 Prospect Form 6 Online Signup Locations Page 6 Online Signup Plans Page 6 Online Signup Info Page 7 Tablet Mode 7 Employee Portal URLs 8 Unbranded Version 8 Branded Version 8 HTML Examples 9 Branded HTML 9 MYiCLUBonline 9 Employee Portal 10 MYiCLUBonline API Guide Monday, February 16, 2015 Classes HTML 12 Linked Class List 12 Embedded Class List 14 Prospect HTML 16 Linked Prospect Form 16 Embedded Prospect Form 17 Online Signup HTML 19 Linking to the Locations Page 19 Linking to the Plans Page 21 Linking to the Info page 23 Branding 24 2 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Introduction This guide provides all of the information you need to link to MYiCLUBonline and Employee Portal from a club’s website. Or you may choose to publish these URLs in other literature, email messages, or communications to club members or employees. Every client is encouraged to take advantage of the MYiCLUBonline branding feature available in the Online Business Center at www.abcfinancial.com. There you can upload the club’s own logo. For instructions, please refer to the Branding section. For the MYiCLUBonline Basic version, no other client setup besides branding is necessary. For the MYiCLUBonline Premium version, which includes the Employee Portal, a number of settings and controls must be completed. For more information, refer to the MYiCLUBonline Setup Checklist. Revisions to this Document Date Added / Updated Content Removed Content August 2, 2013 Online Signup Locations page Online Signup Plans page Online Signup Info Page Tablet Mode Online Signup HTML Online Signup Enrollment August 13, 2013 Class List URLs Class Search URLs 3 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 MYiCLUBonline URLs Use the URLs in this section to link to MYiCLUBonline from a website or provide members with a link in club communications. Note: Examples with HTML are in the HTML Examples section. Some features offer URLs with contents more suitable for embedding frames. Unbranded Version The unbranded version uses the MYiCLUBonline default logo. The following is the URL for the unbranded version: https://mico.myiclubonline.com/iclub/members/signin.htm Branded Version The branded version uses the club’s logo. For instructions on uploading your logo, please refer to the Branding section. The following is the URL for the branded version: https://mico.myiclubonline.com/iclub/members/signin.htm?clubNumber= [clubNumber] For example: https://mico.myiclubonline.com/iclub/members/signin.htm?clubNumber=9003 Class List Your club’s class list is available through the MYiCLUBonline sign-in page. You can link to the class list directly from your website or use it in an iframe on your website so it appears to be built into your club’s website. Note: Class lists are available for clubs that have online class enrollment enabled with classes on the calendar in DataTrak. Linked Class List The following is the URL for the linked class list: https://mico.myiclubonline.com/iclub/members/signin.htm?clubNumber= [clubNumber]#classes For example: https://mico.myiclubonline.com/iclub/members/signin.htm?clubNumber=9003#classes 4 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Embedded Class List The following is the URL for the iframe-suitable class list: https://mico.myiclubonline.com/iclub/classlist.htm?clubNumber= [clubNumber] For example: https://mico.myiclubonline.com/iclub/classlist.htm?clubNumber=9003 Class Searches Here are some scenarios where you might want to use a class list based on a search: • Display a list of classes on a trainer’s Bio page on your website that shows the classes they are teaching. • Get today’s classes for a location so you can print the schedule to post next to the door of the room for the day. • Display a list of classes with a specific word in the title. The following is the URL for classes based upon a search term: https://mico.myiclubonline.com/iclub/classlist.htm?clubNumber= [clubNumber]&search=[searchTerm] Note: When your search term includes a space, replace the space character with %20. Example Trainer Search Here is an example search for a trainer named “John Jones”: https://mico.myiclubonline.com/iclub/classlist.htm?clubNumber=9003&search=john%20jones Example Room Search Here is an example search for classes taking place in a room named “spinning room”: https://mico.myiclubonline.com/iclub/classlist.htm?clubNumber=9003&search=spinning%20room Example Class Name Search Here is an example search for a class named “Zumba”: https://mico.myiclubonline.com/iclub/classlist.htm?clubNumber=9003&search=zumba 5 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Prospect Form The MYiCLUBonline prospect form is useful for collecting personal information from a potential member. It can be used for collecting a person’s information for future contact by the club or for allowing them to sign-up for a free trial membership. When an individual completes the form that person’s data is immediately available in DataTrak as a prospect member. The following is the URL for the prospect form: https://mico.myiclubonline.com/iclub/trial.htm?clubNumber=[clubNumber] For example: https://mico.myiclubonline.com/iclub/trial.htm?clubNumber=9003 Use this URL to link to the form directly from your website or use it in an iframe on your website so it appears to be built into your club’s website. For more information, see the HTML Examples section. Online Signup Locations Page The Online Signup locations page allows the member to select a club from a club list, and to see the clubs on a map. The following is the URL for the Online Signup locations page: https://signup.myiclubonline.com/iclub/signup/home.htm#location ?companyId=[companyId]/selectPlan.htm For example: https://signup.myiclubonline.com/iclub/signup/home.htm#location?companyId=481902F44C80A555E0400 07F010009D0 Online Signup Plans Page The Online Signup Plans page effectively skips the Locations step of the Online Signup process, and allows the member to begin by selecting a club plan. The following is the URL for the Online Signup plans page: https://signup.myiclubonline.com/iclub/signup/home.htm#plans?cl ubNumber=[clubNumber]/selectPlan.htm For example: https://signup.myiclubonline.com/iclub/signup/home.htm#plans?clubNumber=9003 6 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Online Signup Info Page You can also link directly to the Info page by using the PlanId in the URL. This will bypass both the Locations page and the Plans page. The following is the URL for the Online Signup Info page: https://signup.myiclubonline.com/iclub/signup/home.htm#info?clubNumber=9 003&planId=[planId] For example: https://signup.myiclubonline.com/iclub/signup/home.htm#info?clubNumber=9003&planId=229fc64d4c5449 75b74d448b912f1b30 Tablet Mode To enable the in-club tablet mode (such as for Online Signup), add the following to the end of the URL: &clubIPad=true For example: https://signup.myiclubonline.com/iclub/signup/home.htm#location?companyId=481902F44C80A555E0400 07F010009D0&clubIPad=true 7 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Employee Portal URLs The Employee Portal is part of Premium MYiCLUBonline. Use the URLs in this section to link to Employee Portal from a website or provide employees with a link in club communications. Unbranded Version The unbranded version uses the MYiCLUBonline default logo. The following is the URL for the unbranded version: https://portal.myiclubonline.com/employee.htm Branded Version The branded version uses the club’s logo. For instructions, see the Branding section. The following is the URL for the branded version: https://portal.myiclubonline.com/employee.htm?clubNumber=[clubNumber] For example: https://portal.myiclubonline.com/employee.htm?clubNumber=9003 8 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 HTML Examples The links referenced above can be embedded as hyper links in text, an image, or a button on the club’s own website or in email messages. Additional options may be set to further format the actual link on the web page. This section provides example code to link the various MYiCLUBonline pages. Note: These examples use club number 9003. You will need to replace “9003” with your own club number. Branded HTML MYiCLUBonline You can add a link to MYiCLUBonline from your club’s website as shown below: <a href=”https://mico.myiclubonline.com/iclub/members/signin.htm?clubNumber =9003”>Member Login</a> Here is an example of how the Member Login link is represented on a club’s website, using a graphic button: 9 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 When members click the link, they get the opportunity to sign in (or create an account). The club logo is displayed in the upper left corner of the sign in page. Here is an example of the branded MYiCLUBonline member sign in page: Employee Portal You can add a link to Employee Portal from your club’s website. The following is the HTML for linking to Employee Portal from your website: <a href=”https://portal.myiclubonline.com/employee.htm?clubNumber=9003”>Emp loyee Login</a> 10 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Here is an example of how the Employee Login link is represented on a club’s website, using a graphic button: When employees click the link, they get the opportunity to sign in. The club logo is displayed in the upper left corner of the sign in page. 11 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Here is an example of the branded Employee Portal sign in page: Classes HTML You can link to the class list directly from your website or use it in an iframe on your website so it appears to be built into your club’s website. Linked Class List Using the class list with a direct link will take the user away from your website. It is recommended that the link is opened in a new window or tab (target="_blank") so when the user closes it they will still have the club’s website open. The following is the HTML for linking to your class list from your website: <a href="https://mico.myiclubonline.com/iclub/members/signin.htm?clubNumber =9003#classes" target="_blank" title="Class list">Classes</a> 12 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Here is an example of how the Classes link is represented on a club’s website: 13 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 When someone clicks the Classes link, the class list opens in a new window as shown below. Embedded Class List When displaying your club’s class list in an iframe on your website, let the visitor know they need to sign in to MYiCLUBonline to enroll in a class and that if they are not a member of your club, have a Join Now link to allow them to join online. The following is the HTML for embedding your class list in an iframe on your website: <!-- ABC classlist --> <table style="width:100%;"><tr><td align=center> <iframe src="https://mico.myiclubonline.com/iclub/members/classlist.html?clubNumber=9003" height="800" width="720" frameborder="0" style="border:solid 4px #FEE616;border-radius:6px;-moz-border-radius:6px;"> </iframe> </td></tr></table> <!-- end ABC classlist --> Note: The inline CSS style is optional. It was included to show how you can use one of your club colors to accent around the iframe with a border. If your website background is white, you may not want to have a border around the iframe. 14 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 When someone clicks the Classes link, another page on the club’s website opens containing an iframe embedding the club’s class list as shown below. 15 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Prospect HTML You can link to the prospect form directly from your website or use it in an iframe on your website so it appears to be built into your club’s website. Linked Prospect Form Using the prospect form with a direct link will take the user away from your website. It is recommended that the link is opened in a new window or tab (target="_blank") so when the user closes it they will still have the club’s website open. The following is the HTML for linking to your prospect form from your club’s website: <a href="https://mico.myiclubonline.com/iclub/trial.htm?clubNumber=9003" target="_blank"> <img src="/images/trialpass.jpg"></a> In the following example, the club has added a Trial Pass button on their website that points to the MYiCLUBonline prospect form: 16 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 When someone clicks the Trial Pass button, the prospect form opens in a new window as shown below: Embedded Prospect Form Embedding the prospect form in an iframe on your club’s website gives you more control of the content around the form. Create a page on your website that contains information explaining why the user is signing up. Some ideas to have displayed above the embedded prospect iframe form include: • A simple header such as “Get a Free 7-day Trial.” • Promotional details to sign up for more information. • A bulleted list of benefits with your club and have a link to Join Now or let them sign up for the free trial in the prospect form. 17 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 The following is the HTML for embedding your prospect form in an iframe on your website: <!-- ABC Prospect Form Code --> <table style="width:100%;"><tr><td align=center> <iframe src="https://mico.myiclubonline.com/iclub/trial.htm?clubNumber=9003" height="814" width="720" frameborder="0" style="border:solid 4px #FEE616;border-radius:6px;-moz-border-radius:6px;"> </iframe> </td></tr></table> <!-- end ABC Prospect Form Code --> Note: The inline CSS style is optional. It was included to show how you can use one of your club colors to accent around the iframe with a border. If your website background is white, you may not want to have a border around the iframe. When someone clicks the Trial Pass link, another page on the club’s website opens containing an iframe embedding the club’s prospect form as shown below: 18 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Online Signup HTML Linking to the Locations Page You can add a link to the MYiCLUBonline Online Signup form from your club’s website. This will link to the Locations page, where the member can select a club in your company by location. The following is the HTML for linking to your online from your club’s website: <a href=”https://signup.myiclubonline.com/iclub/signup/home.htm#location?co mpanyId=481902F44C80A555E040007F010009D0”>Join Now</a> 19 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 In the following example, the club has added a Join Now button on their website that points to the MYiCLUBonline Online Signup Locations page: If a member clicks the Join Now link, the Locations page will be displayed: 20 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Linking to the Plans Page If you would prefer to skip the Locations page and link the member directly to the Plans page, the following HTML should be used: <a href=”https://signup.myiclubonline.com/iclub/signup/home.htm#plans?clubN umber=9003”>Join Now</a> In this case, the club has been defined in the URL, rather than selected by the member on the Locations page. In the following example, the club has added a Join Now button on their website that points to the MYiCLUBonline Online Signup Plans page: 21 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 If the member clicks the Join Now link, the Plans page will be displayed: 22 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Linking to the Info page You can also use the club number and PlanId in the URL to link directly to the Info page. This is where the member enters his information for a preselected plan. <a href=”https://signup.myiclubonline.com/iclub/signup/home.htm#info?clubNu mber=9003&planId=229fc64d4c544975b74d448b912f1b30”>Join Now</a> When the member clicks this link, the Info page will appear. The plan will display in the right sidebar: 23 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential MYiCLUBonline API Guide Monday, February 16, 2015 Branding For club-specific branding, sign in to the ABC Financial Online Business Center (www.abcfinancial.com). Use the Branding link under MYiCLUBonline Maintenance to upload a club-specific logo. To brand MYiCLUBonline for a club: 1. Log in to the ABC Financial Online Business Center (www.abcfinancial.com). 2. Select the club and click Submit. 3. In the left sidebar menu, click the Branding link under MYiCLUB Maintenance. 4. Upload the club logo. 5. Select the clubs for which you wish to use this logo. 6. To receive notification of online enrollment, type an email address in the Signup Notifications section. If entering multiple email addresses, separate them with a comma. 7. Click Save. 24 © 2015 ABC Financial Services, Inc. All rights reserved. Confidential