• Replies 9 replies
  • Subscribers 337 subscribers
  • Views 363 views
  • Users 0 members are here
Related

Trying to play with REST API - connection settings? And I can't find documentation

Former Member
Former Member $organization

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.

Parents Reply Children
  • Former Member
    Former Member $organization in reply to Gawain Lavers

    Hi Gawain,

    Ah ok, yes we are RAMP hosted. I'll reach out to TASK to whitelist our IP

    Thanks,

    -Ben

  • $organization in reply to Former Member

    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.

    --Gawain

  • Former Member
    Former Member $organization in reply to Gawain Lavers

    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!

    -Ben

  • $organization in reply to Former Member

    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).