iGrafx API

The iGrafx API is used to send the CSV file to the API. The file transfer to the API is handled in adapters/api/MainApiImpl.scala by the sendCsvToIGrafx method, which takes as parameters the connector's properties and the path of the file to send.

To send the file, follow these two steps:

  1. Retrieve the connection token:
    Use the URL path {authUrl}/protocol/openid-connect/token**, where *{authUrl}* corresponds to the **api.authUrl property of the connector. The request also includes details about the workgroup ID and workgroup Key. Upon success, the HTTP response contains a JSON object with an access_token key.

  2. Send the file:
    Use the URL {apiUrl}/project/{projectId}/file?teamId={workGroupId}, where {apiUrl} corresponds to the api.url property of the connector. This request requires information about the workgroup ID, project ID, file path, and the previously obtained token.

The Workgroup ID, Workgroup Key, API URL and API Auth URL can be found in the iGrafx workgroup settings, under the Open API tab.