Custom API
      Back to home
      1. Help Center
      2. Integrations
      3. Custom API

      Custom API and iFrame

      Send leads from your website to MyStudio and integrate your product offerings into your website.

       

      Table of contents

       

      Permissions and accessibility

      Staff access:

      • Admin: full access
      • Manager: no access
      • Staff: no access

      MyStudio plan restrictions:

      • Starter: not available
      • Growth: 2 custom API keys allowed
      • Scale: 5 custom API keys allowed

       

      ^ back to top

       

      Pricing

      If using Zapier in conjunction with the custom API, you will need to pay for a Zapier pro account and will be charged per zap according to their pricing. See Zapier’s pricing page here: Workflow automation plans

       

      ^ back to top

      Custom API

      What is a custom API used for?

      While our Zapier integration allows you to send leads from MyStudio to other platforms or from other platforms to MyStudio, our custom API keys only send leads from other platforms to MyStudio.

       

      Custom API keys allow for direct access whereas Zapier connections create a pipeline. This, in turn, allows more control and less dependence on third party connections.

      custom api

       

      ^ back to top

      What is needed before setting up a custom API?

      Before setting up a custom API, you will need to ensure you have sources and program interests set up for your leads. To do so:

      1. In V1, go to all customers > leads.
      2. Go to the “settings” subsection.
      3. Click the drop down for sources and add all possible options.
      4. Click the drop down for program interests and add all possible options. We recommend that these reflect your product offerings for better tracking and data analytics.

      Important: if these are not set up, any leads coming into MyStudio will show as source and/or program interest as “not specified.” These cannot be edited later.

      lead settings

       

      ^ back to top

      Create API key

      To create a custom API key:

      1. In V2, go to integrations > custom API.
      2. Click “connect.”
      3. Click “create a new key.”
      4. Name the API key and click “create API key.” The key will be successfully added to the list.

      Note: the number of keys you are able to create is related to your MyStudio plan.

      • Starter: not available
      • Growth: 2 custom API keys allowed
      • Scale: 5 custom API keys allowed

      create new key

       

      ^ back to top

      Code API key into your website

      If you are hard coding the API callback, you will need to parameterize the data by entering the following code snippet, where the text after the colon (:) symbolizes the data customers will enter into the lead capture fields.

      {

      "Buyer_first_name":"Rajesh",

      "Buyer_last_name":"S",

      "Email":"rajeshsankar.k@technogemsinc.com",

      "Phone":"123789456",

      "Source":"____",

      "Program_interest":"____",

      "Participant_first_name":"Jeeva",

      "Participant_last_name":"R",

      "Campaign":"Yes"

      }

       

      Important:

      Source: enter one of your source options such as “Facebook” instead of the underscores. This would be the platform you are hard coding the lead capture into, such as “website” when you’re placing this code into your website. This must match EXACTLY as you’ve entered in your all customers > leads > settings > source section. It is case sensitive.

       

      Program_interest: enter one of your program interest options such as “After School Program” instead of the underscores. If you have more than one program interest listed in all customers > leads > settings > program interests, then you will need to fill out this parameter listing for each program interest. This must match EXACTLY as you’ve entered in your all customers > leads > settings > program interest section. It is case sensitive.

       

      Campaign: you can either enter “yes” or “no,” but you can also enter a specific lead campaign title that you created in automations > lead campaigns.

       

      ^ back to top

      iFrame

      What is iFrame?

      iFrame tags allow you to embed product offering links into your website. This means you could attach different offering URLs directly into your website. 

       

      ^ back to top

      Locating product offering URLs

      Product URLs are currently in V1.

      • Trials: Go to services and products (the sales tag icon) > trials.
        • For all trials, go to the settings subsection and copy the trials URL.
        • For specific trials, click the “URL” button on the specific trial listed under live trials.
      • Memberships/Programs: Go to services and products (the sales tag icon) > programs/memberships.
        • For all programs/memberships, go to the settings subsection and copy the programs URL.
        • For specific programs, click the “URL” button on the specific program listed under live programs.
        • For specific membership options, click the pencil icon on the program and click the “URL” button on the specific membership option listed under live membership options.
      • Classes: Go to services and products (the sales tag icon) > class schedule.
        • For all classes, go to the settings subsection and copy the class appointment URL.
        • For specific classes, click “copy URL” on the specific class listed under live programs.
      • Events: Go to services and products (the sales tag icon) > events.
        • For all events, go to the settings subsection and copy the events URL.
        • For specific events, click the “URL” button on the specific event listed under live events.
      • Retail: Go to services and products (the sales tag icon) > retail.
        • For all retail, go to the settings subsection and copy the retail URL.
        • For specific retail categories, click “copy URL” on the specific retail category listed under live products.
        • For specific retail items, click “copy URL” either on the item listed under live products or click “edit items” on a product category and “copy URL” from within a product category.

       

      ^ back to top

      Setup iFrame on your website

      1. Locate the URL you would like to post. Remember that most offerings have a main URL that will show all listings and specific URLs that will show individual listings.
      2. Place the URL inside the iframe tag within your desired website code location.

      iFrame tag:

      <iframe src="https://putyourURLhere"></iframe>

       

      ^ back to top

      Frequently asked questions (FAQs)

      For iFrame, can I get URLs for specific class times or event date/options?

      No, unfortunately there are currently no URLs for individual event date/options or class times.

       

      ^ back to top

      For iFrame, what happens if I have private memberships or events?

      Private memberships and events will not show as a listing option if you are using general URLs. Private memberships and events will only display in the staff POS or if you use the specific URL for the individual membership or event.

       

      ^ back to top

      Can I use custom API to import information besides leads?

      No, at this time our custom API will only work for lead info retrieval.

       

      ^ back to top

      Can I delete a custom API connection?

      Yes! To delete a custom API connection:

      1. In V2, go to integrations > custom API.
      2. Click "modify."
      3. Click the trash can icon next to the listed API key.

      delete custom key

      ^ back to top

      I want to use Zapier.

      Zapier is great for both retrieving and sending lead information between MyStudio and other platforms. For more information on this set up, check out one of our articles below:

       

      ^ back to top