Tres API

The Tres API is a mechanism whereby you can access the underlying Tres data in a programmatic way.

Skip To: 

Tres API Overview

Why use the Tres API?

How to use the Tres API

Tres API FAQ

Tres API Overview

• The Tres API is a mechanism whereby you can access the underlying Tres data in a programmatic way.
• All data is available via the API. 
• Permissions work the same way as with the Tres app. 
• Do I need to be a developer to use the API?

Why use the Tres API?

• Create a customized client intake form.
• Create custom dashboards for advisors.
• More precise control over extracted data.
• Create custom import/update scenarios for clients, trips, etc.

How to use the Tres API

Workflow

• Start a session by calling login passing in credentials and get a token in response.
• Perform one or more operations using token (search, load/create/update/delete).
• End the session via logout.

API Layout

• System methods
  • Login/Logout
• Area-specific methods
  • Areas include trips, profiles, payments, etc.
  • Search methods
    • Profile search example: Show me a list of the client profiles in 90045 zip code who booked a trip of at least $5000 last year.
    • Trip  search example: Give me a list of trips that have a destination of Hawaii.
• Load/update methods
  • Create a trip
  • Update a client profile to add an email address.
  • Link a traveler to a client profile.

 

API Documentation (in progress)

• Tres Dev Portal
  • https://devportal.trestechnologies.com
  • Includes list of available methods and their parameters, code samples, data dictionary
• Swagger
  • https://api-dev.trestechnologies.com/swagger/index.html

 

Working with JSON

• Communication with the API is done using JSON (JavaScript Object Notation).

{

  "first_name": "John",

  "last_name": "Smith",

  "address": {

    "street_address": "21 2nd Street",

    "city": "New York",

    "state": "NY",

    "postal_code": "10021-3100"

  },

  "children": [

    "Catherine",

    "Thomas",

    "Trevor"

  ],

  "spouse": "Mary"

}

• Online Json viewer: https://jsongrid.com/json-viewer

Using Postman to interact with the API

Postman is an application designed to let you interact with APIs: https://web.postman.co

Tres API FAQ

• How do I integrate Tres with (some-random-application) via the API?
  • You would use a developer to help you use the Tres API.
• Is there a charge for using the API?
  • There is no charge for using the Tres API.
• Can I set up a sandbox account so I can play with the API using test data?    
  • Email [e-mail].
• How do I get support for API questions?
  • Email [e-mail] and we will get the support ticket routed to our API Development team.
• Are there TCCs that can help me?
  • We do not currently have TCCs that work with the API.  We are hoping to have TCCs that specialize in the API soon and will update the TCC list on the Tres Technologies website.

Tres API Links

• Tres Technologies Developer Portal: https://devportal.trestechnologies.com
• Postman: https://web.postman.co
• Tres Postman sample collection https://static.trams.com/TramsLibrary/documentation/Tres/API/Tres%20API%20samples.postman_collection.zip
• Online Json Viewer: https://jsongrid.com/json-viewer
• API support: https://support.trestechnologies.com