Use the Tamr APIs to perform all tasks available from the Tamr user interface (UI), as well as certain tasks that can be performed only via the APIs. The Tamr APIs return data based on the user’s permissions and role.
This reference guide describes using the APIs via cURL, Node, Ruby, PHP, and Python commands. You can also interact with the Tamr APIs through:
- Swagger API documentation, described in the section below.
- Tamr Python Client, a specialized library used for direct interactions with Tamr.
- Tamr Toolbox, a Python library created to provide a simple interface for common interactions with Tamr and common data workflows that include Tamr.
Tamr provides versioned and non-versioned APIs. Tamr highly recommends using versioned APIs only and does not guarantee continued support for the non-versioned APIs.
In the Swagger API documentation, select versioned from the top Service menu to view documentation only for versioned APIs.
Swagger API documentation is installed with Tamr and is available at http://<tamr_ip>:9100/docs. You can execute API calls through the Swagger documentation interface, which can be useful for single time actions or to test calls for an automated workflow.
In the Swagger documentation, API endpoints are separated into several different services. Tamr highly recommends using the versioned APIs only, as shown in the image below.
To execute API calls in the Swagger documentation:
- Navigate to the service you want to execute.
- Enter your username and password for the Tamr instance at the top of the page and select Use Credentials.
- Identify the functionality you want to execute. Select the endpoint (for example, GET/v1/datasets) to expand the information panel on this API endpoint.
- Enter any required information into the text fields.
- Select the Try it Out button to submit the API call. The response appears below the button.
Tip: If the result is an error, check that you entered the required information in the correct format, and read the error message to understand the problem.
Each time you select the Try It Out button, the cURL command that can be used to make that same API call appears, as shown in the image below. When you are comfortable using the APIs, you can copy these commands to modify and use them.