The SOAP API will be removed in the upcoming release of Tessitura v16. Get ready by switching to the REST API-only. Other benefits of switching include:
- Improved app performance and loading times
- Tools to test digital tickets and memberships
- Select from drop down lists instead of looking up ID's in Tessitura
This does not change the functionality of your app. You still have the great features you're used to such Digital Tickets, Membership, and more.
Prerequisites
-
REST User Credentials: Verify that your REST API settings are correct. Go to the API Settings (Control Panel > InstantApps > Tessitura) and open the REST API Settings section. As long as you don't see an error message here you are good to go.
-
REST Permissions: Ensure that the REST User Group you are using has the proper permissions. This requires help from someone that can access the Tessitura Security application. See How do I configure permissions for the REST API?
How to switch
Screenshot of the page for switching to REST API-only.
- Go to the API Settings (Control Panel > InstantApps > Tessitura).
- Click the Review and switch button.
- If necessary, fix any issues that are identified with your REST API user and credentials.
- Choose from the drop downs the appropriate values for Original Source and Phone Type. These two new settings are used when a user creates an account through the app.
- Follow the instructions to check the Reprint Minutes setting in Tessitura. Check the box to confirm. See How do I check the Reprint Minutes Setting?
- Click the Switch button. You will be taken to the new Tessitura settings page.
Don't worry, if you have any issues with the REST API-only, you can go back to using the SOAP API temporarily.
Try it first using Test Mode
Want to test the REST API-only version first? You can use Test Mode. This is a completely separate account and changes won't affect your live app.
- Log into the Control Panel.
- Click Test Mode from the navigation menu on the left.
- Click Turn On. Optionally, you can copy setting from your Live to Test account.
- To exit Test Mode, follow the same steps as above, but choose Turn Off.
In Test Mode you can set your Tessitura settings and preview the app as normal in the Control Panel.
If you have used Test Mode previously, you will need to go through the steps above to switch from SOAP to REST.
If this is the first time you are using Test Mode, the test account will be created with REST API-only turned on already.
What to test after switching
Here are some features you may want to verify are working as expected after you make the switch:
-
Event listings
-
Log in
-
View account info
-
View Tickets
-
View Membership card
-
Order History
-
Register account
Interests Changes
Interests can be displayed in the app on the Register screen or My Account area. In the SOAP API version, interests were configured in system tables setup for TNEW. These settings have been moved to the Control Panel to make it easier to manage them.
To use Interests in the REST API-only version you will need to set them up after switching.
For more information see: How do I set up Interests?
Purchase Path Changes
The REST API-only integration uses your TNEW or custom website purchase path to complete purchases. When a user clicks the "Get Tickets" button they are redirected to the appropriate page within the app's internal browser. You can use the Purchase Path URL pattern to automatically setup the correct link for all your performances.
For more information see: How do I setup the app to use my mobile-friendly website's purchase path?
With the switch to the REST API, we will be ending support for the legacy in app purchase path. Most users have already made this switch.
To make this process easy for your patrons, you can enable Shared Session. This automatically logs in users when they go to your TNEW website with the same account they were using in the app.
For more information see: How do I set up Shared Session?
Forgot Login Email Changes
The REST API requires an HTML template for the Login Credentials email. However, since many organizations haven't created these yet, the app will fallback gracefully to the SOAP API if necessary. This way you can switch to the REST API now, and upgrade to HTML emails later. This will work until Tessitura v16, at which point the SOAP API will no longer be available.
For more information see: How do I set up the Forgot Credentials email when sent by the REST API?
Verify your Reprint Minutes Setting
To ensure that patrons can access their tickets after the performance start time (for example if they are arriving right as the show starts), please ensure that Reprint Minutes is set to a reasonable value. The behavior of this setting is different for the REST API vs the SOAP API, so it is important that you check it.
For more information see: How do I check the Reprint Minutes Setting?
Other benefits of this update
Improved app performance
- App load times are 2-3 times faster.
- Requests to the REST API are faster and more reliable.
Tools to test digital tickets and memberships
Use the Tickets Search if patrons have a question about their tickets in the app. Put in their email or Constituent ID and see exactly which tickets are in their app.
The Standard Membership Card has a test option now. Put in a constituent's email or ID and view the data that will be in their Membership card.
Select from drop down lists instead of looking up ID's in Tessitura
No more looking up ID's in Tessitura and then copying them to InstantEncore. Most fields now allow you to select from a drop down list of options. This saves you time and prevents mistakes.
It even works when you can select more than one value for a field.
Questions or issues?
We're excited for the next generation of the InstantApps Tessitura integration using the REST API. Please let us know if you have any questions for feedback about this process at support@instantencore.com.