General
Both the NTI INTEGRATOR Client running as an Autodesk Vault AddIn and the standalone NTI INTEGRATOR File Importer uses the INTEGRATOR .NET API. When either of the two clients are installed, the API is also included. Current .NET Version of the API is .NET Framework 4.7.1. The location of the files is in the folder ‘%ProgramData%\NTI\Integrator\Common’. The files needed to write a custom application for integrating with the INTEGRATOR Server is:
- iConnect.Client.API.dll:
This file contains all UI components like the settings dialog and login dialog etc. - iConnect.Client.API.Library.dll:
This file contains all the API functions needed for connecting and sending Transactions to the INTEGRATOR Server. It also contains functions for retrieving data from the server. - iConnect.Library.Common.dll:
This file contains all the model class objects that are used by the API assembly files.
Open API (REST)
Another option to integrate with INTEGRATOR Server is to use the REST API directly. This is also used by the provided .NET Framework API.
Authorization
To get a valid token (Bearer) from INTEGRATOR Server, a POST call to the URL ‘{SERVERADRESS}/api/authentication/gettoken’ is made. The body of the call needs to contain the username and password for the user to get token for in JSON format. Content-Type needs to be set to “application/json” in the Header. As an example:
{
“username” : “jobserver”,
“password” : “jobserver”
}
If a successful authentication is performed, the response status code is a “200 OK” and the body will contain the access token needed to call the rest of the API endpoints.
Call a REST endpoint
When calling a REST endpoint in INTEGRATOR Server that requires validation, the received access token needs to be included in the call’s Header parameter “Authorization” and is a Bearer token.
Note: The available REST endpoints is not covered in this documentation.