Skip to content

6. Integrations: external feeds and APIs

Jump to bottom
Armando Fox edited this page Feb 6, 2021 · 1 revision

External Integrations

The following mechanisms may help you integrate Audience1st with your theater's content site. All URLs below are relative to the base URL of your deployment.

Links for donations

URL /donate takes the patron to a "quick donate" page where they can make a credit card donation without logging in or having an account. Donations go to the default donation fund specified at setup time.

URL /donate_to_fund/nnnn takes the patron to a page coded to donate to the fund whose account code number is nnnn, for specific fundraising campaigns. For example, if you have a fund coded 83956 for a particular project, /donate_to_fund/83956 will go to a page that accepts donations to that fund.

Links for purchasing tickets, camps, subscriptions

  • /store goes to the purchase page for regular show tickets.

  • /store?what=Class goes to the purchase page for classes and camps.

  • /store?what=Special+Event goes to the purchase page for special events. (Patrons can easily switch among the regular tickets, classes, and special events pages, so these mechanisms are for convenience.)

  • /store?show_id=nnnn goes to a purchase page prepopulated for the production (show) whose ID is nnnn. In the Season Setup view, there are buttons to generate the link text for any of the productions. Note that a class/camp or special event is also a production, so you can also use this mechanism to send the patron to a purchase page for a particular class/camp or special event.

  • /store?showdate_id=nnnn goes to a purchase page prepopulated for a specific performance of a production, where the performance's ID is nnnn. In the Season Setup view, click on a show's name to display the list of performance dates; next to each date is a button to generate the link text for that performance. For classes/camps, you can use this to send the patron to a purchase page prepopulated for a particular session ("performance date") of a class/camp.

  • /subscribe goes to the main subscription purchase page.

RSS feeds

Audience1st has RSS feeds of real-time ticket information. Many Web authoring tools such as WordPress and Drupal have RSS plug-ins.

  • /rss/ticket_rss returns an RSS feed of the next 3 months' worth of shows, classes and special events.

  • /rss/ticket_rss?what=list returns an RSS feed of only the next 3 months' worth of things in list, which should be a hyphen-separated list of one or more of the following: Show, Class, Special+Event. For example /info/ticket_rss?what=Class-Special+Event returns the classes and special events in the next 3 months, but not the regular shows. The returned items look like this:

    <item>
      <title>A - Camp Three 2015 - Monday, Jul 27, 9:00 AM (First Day of Camp) - SOLD OUT</title>
      <guid permalink="false">http://www.audience1st.com/ccct/store?showdate_id=424&amp;amp;ts=1433811199&amp;amp;what=Special+Events</guid>
    </item>
  • /rss/availability?q=lookahead returns availability information for all performances in the next lookahead days (defaults to 90 days if omitted). The availability record includes various show metadata including the "availability grade": 0 (sold out), 1 (nearly sold out), 2 (limited availability), 3 (good availability). The thresholds for these availability grades, as a percentage of the house sold, are options settable via the Options nav tab.

The feed returns a series of items, each of which looks like this (note the inclusion of an easy-to-parse ISO 8601 format for the performance date and time):

    <item>
      <title>Castle Happy (Alternative Altarena) - Thursday, Jul 27, 8:00 PM</title>
      <link>https://www.audience1st.com/altarena/store?showdate_id=1473</link>
      <guid isPermaLink="false">https://www.audience1st.com/altarena/store?showdate_id=1473</guid>
      <audience1st:show>Castle Happy (Alternative Altarena)</audience1st:show>
      <audience1st:showDateTime>Thu, Jul 27,  8:00PM</audience1st:showDateTime>
      <audience1st:showDateTime8601>2017-07-27T20:00</audience1st:showDateTime8601>
      <audience1st:availabilityGrade>2</audience1st:availabilityGrade>
      <audience1st:priceRange>$24.00 - $30.00</audience1st:priceRange>
    </item>
Clone this wiki locally