Integration API

The Integration API allows you to easily integrate TeamDesk with your applications and build new applications that work with TeamDesk.

When you click Setup > Database tab > Tools > Integration API, the following form is displayed:

REST API

TeamDesk provides a REST API to simplify integration with other services.

Three choices are available for the REST API:

• Enabled tokens and users - This is the default option. It allows REST API use for everyone who has user/password authorized access to the database.
• Enabled tokens - This option limits API access to the token authorization method. As a result, you can control the use of the API precisely.
• Disabled - Using this option, you can disable the API entirely.

When you change Rest API options, you should click the Update button to save the changes.

REST API Playground

The Rest API Playground button (or the REST API page link) navigates you to the TeamDesk REST API playground, allowing you to experiment with API calls.

More details are described in the TeamDesk REST API.

REST API Errors

The Rest API Errors button opens the Rest API error log. For example:

This error log can be exported to a CSV file if you click the Export to CSV button.

REST API Logs

The Rest API Logs button opens the Rest API log. In the filters, you can select the Method for which you need the log. You may also select a specific table, duration, and user to sort out unnecessary data.

SOAP API

You can enable or disable the SOAP API.

Please note that the SOAP API is obsolete; therefore, we don’t recommend using it.

Each database has its own web service address. To get the API URL for your database, click on Setup > Database tab > Tools > Integration API and select the TeamDesk SOAP API link.

The link will navigate you to a page containing a formal description of the web service. All calls to the web service are made via the same URL. You can retrieve the service definition in WSDL format by adding ?wsdl to the end of the URL.

The Integration API assumes knowledge of web services concepts, the SOAP protocol, XML, and XML Schema (XSD) formats. It does not describe how to call a web service using product X; you can find this information in the corresponding product documentation.