Integration - Application Programming Interface (API)
TeamSupport API
Introduction
The TeamSupport API is a RESTful style API over HTTP using XML. Each object (Tickets, Customers, Products, etc...) in TeamSupport is treated as a resource. You can use four verbs (GET, POST, PUT, DELETE) to manipulate the data.
Authentication
To gain access to your data, you must get authenticated. TeamSupport uses HTTP Basic Authentication over SSL to secure your data. You will use your OrganizationID for your username, and your authentication token as your password. Your authentication token allows access to your data, so be sure to keep it very secure. You will be able to reset your authentication token in the TeamSupport application. Go to Admin->My Company and look in the Properties section to find your OrganizationID and to reset your authentication token.
Verbs
An easy way to test your calls is to use a HTTP client such as Fiddler or cURL. You can even test the GET verb with a standard web browser.
GET (Retrieve)
The GET verb allows you to retrieve the data.
Example 1: https://app.teamsupport.com/api/xml/customers will retrieve all of your customers.
Example 2: https://app.teamsupport.com/api/xml/customers/123 will retrieve a single customer with the CustomerID of 123.
You also have an option of appending ".xml" to the resource. This might be useful for some clients to display the proper XML format.
Example: https://app.teamsupport.com/api/xml/customers.xml
POST (Insert or Create)
The POST verb will allow you create resources.
Example: https://app.teamsupport.com/api/xml/customers
Using the POST verb, a new customer will be created. You need to put the XML of your new customer in the body of the HTTP request.
PUT (Update)
The PUT verb is much like the POST, except that it updates an existing resource instead of creating a new one.
https://app.teamsupport.com/api/xml/customers/123
You will need to put the XML in the body of the request. An easy way to see the format, is to use the GET verb to request a resource.
DELETE
The DELETE verb is pretty much straight forward. You issue an HTTP request upon a resource, and that resource will be deleted.
Example: Tickets/123/Customers/456
Customer 456's association with ticket 123 will be deleted.
Responses
When you receive a response back from your request, the Status Code is very meaningful. The Status Code determines the success of the request.
Some common codes are as follows:
200 Successful
201 Created
202 Accepted
300 Redirection
304 Not Modified
401 Unauthorized
404 Not Found
405 Method Not Allowed
500 Server Error
501 Not Implemented
Custom Fields
The custom fields that you create will be available like any other property of a resource in TeamSupport. You can modify the property name when you create or edit your custom fields (Admin->Custom Fields). When modifying your custom fields, you will notice a value "API Field Name". This value will determine the element name in your XML.
Click here to access our full API documentation.
|
