Hi I'm trying play around with the API. We are still on Tessitura V12, so I found the documentation on the REST API for that. I installed the Firefox Rest Client extension, but I don't think I am using the right settings for Basic Authentication.
Where can I find documentation the API commands?
Can you tell me where I can find these settings?
Username: <Tessitura user name>:<Tessitura user group>:<Machine name>
https://{site name}/TessituraService/CRM/Constituents/1008
Right now I am using:
<Tessitura user name> == Rest API Username
<Tessitura user group> == Rest API UserGroup
<Machine name> == Server Name (I don't think this is correct)
{site name} == https://test-na-rhof.tn.services (I don't think this is correct)
I blacked out the settings since I wasn't sure if some of the info was senstive, but I left the labels
I know I have the correct username and password for the REST API user.
Hi Ed,
Where do I find my server name? The documentation for how I find the missing pieces of information is unclear.
Where can I find: Tessitura user name, Tessitura user group, Machine name, and site name?
Server name is the name of t the server that your REST API is running on.
In your page from TNEW that will be the full URL for REST API (Live/Test)
User Name and Group are just any combination of user and group that are valid on Tessitura and have access to the Services (in security), if unsure then use the ones TNEW are using and listing on the page you screen shot.
Machine Name is the name of any machine that has been used to run Tessitura - check TX_MACHINE_LOCATION in system tables to find one with a location assigned to it.
Mark
Hi Mark,
I'm still struggling to get to the documentation for v12.5 and where to find the right URL to use the api.
I copied and pasted this from the admin screen:
Here are all the URLs I've tried, all of which the page never loads:
http://192.168.105.115/testapi/TessituraService/Help
https://192.168.105.115/testapi/TessituraService/Help
http://192.168.105.115/liveapi/TessituraService/Help
https://192.168.105.115/liveapi/TessituraService/Help
http://192.168.105.115/TessituraService/Help
https://192.168.105.115/TessituraService/Help
https://ticketing.rockhall.com/testapi/TessituraService/Help
http://ticketing.rockhall.com/testapi/TessituraService/Help
https://ticketing.rockhall.com/liveapi/TessituraService/Help
http://ticketing.rockhall.com/liveapi/TessituraService/Help
https://ticketing.rockhall.com/TessituraService/Help
http://ticketing.rockhall.com/TessituraService/Help
https://test-na-rhof.tn.services/liveapi/TessituraService/Help
http://test-na-rhof.tn.services/liveapi/TessituraService/Help
http://test-na-rhof.tn.services/testapi/TessituraService/Help
https://test-na-rhof.tn.services/testapi/TessituraService/Help
https://test-na-rhof.tn.services/TessituraService/Help
http://test-na-rhof.tn.services/TessituraService/Help
I tried pinging the IP address and didn't get any responses either.
When I enter the correct information for the username:group:machine name and password in the Firefox extension RESTClient it can't connect either.
I suspect that the URL listed in the TNEW dashboard screen is not the URL I need. Where can I find the correct URL?
Hi Benjamin,
That sounds like a firewall issue to me. Is the machine you are trying to connect to the API from whitelisted by the API server?
And are you guys a RAMP client? I seem to remember that. If so you'll need to contact RAMP (TASK ticket) to get the firewall rules changed and also to confirm the URL.
--Gawain
Hi Gawain,
Ah ok, yes we are RAMP hosted. I'll reach out to TASK to whitelist our IP
Thanks,
-Ben
Hi Ben,
To connect directly with a browser, Postman, etc. of course your machine needs to be whitelisted. However, in the past RAMP could also set up a browser in the 2x client that you could use to access the API (for testing purposes) from any machine where you had RAMP access. I'm not sure if that utility is still available with Citrix, but you might ask.
Thanks, I got the info I needed from TASK. I am now able to connect to the API. For other people who are in the same boat, the ServerName ended up being: https://rhofapp.tessituranetworkramp.com
I wish the API documentation was available through the Tessitura website, alongside the rest of the documentation. And I wish I didn't have to reach out to TASK to find basic information about how to connect and use the API. As a user, I want a clear understanding of what I can do with the system I have access to.
Thanks again to everyone for all the help!
Now, to be clear, that url is the API server for _your_ organization (and really? not rrhofapp or rnrhofapp? anyway). It's also clearly the server for your production database; if you're playing about you'll want to be accessing your Test API server instead.
Going through TASK for access (if you're a RAMP client) is unavoidable, as the API server is necessarily protected by a firewall, and only allows incoming connections from whitelisted machines.
There is some documentation on the network site to get you started:
https://www.tessituranetwork.com/Support/Documentation/Tessitura-API
And the REST service url has some pretty good "self documentation" features that will help when digging through the endpoints.
Now, one very important word of caution: it looks like you're still on 12.5. The 12.5 REST API was not considered "stable", and a lot of changes and reorganization happened between 12.5 and 14, so familiarizing yourself with it in 12.5 is certainly not a bad thing, but any applications built will likely have a fair amount of reworking necessary when you upgrade next. The API has a lot of development left to go, but in theory changes should not be as dramatic from 14 on (more additions and bugfixes than changes to existing endpoints).