.NET API
To use the Alteryx API, include AlteryxAPI.Net.dll as a reference in your project. Then, copy the required DLLs to the appropriate folders. The required DLLs are found in the C:\Program Files\Alteryx\bin\ folder in your Alteryx Designer installation.
You must have Visual C++ 2015 installed globally to use the .NET API. Alternatively, you can include the Visual C++ 2015 redistributable DLLs. You can find the DLLs in the Alteryx Designer installation folder: C:\Program Files\Alteryx\bin\.
Copy required DLLs
The .NET DLLs contain resources required by the Alteryx API and must be copied to the appropriate folders for your executable to function properly.
- Create a folder structure to store the required DLLs.
- Include the following DLL as a reference in your project:
C:\Program Files\Alteryx\bin\AlteryxAPI.Net.dll
C:\Program Files\Alteryx\bin\AlteryxDocument.dll
C:\Program Files\Alteryx\bin\Base.Net.dll
- Copy the following DLLs to the same folder where you plan to load AlteryxAPI.Net.dll:
- C:\Program Files\Alteryx\bin\FlxComm64.dll
- C:\Program Files\Alteryx\bin\FlxConnect64.dll
- C:\Program Files\Alteryx\bin\FlxCore64.dll
- Copy the following DLL to the same folder as the executable that will call into AlteryxAPI.Net.dll:
C:\Program Files\Alteryx\bin\Base.dll
Example folder structure
- YourApp.exe
- Base.dll
- Libs
- AlteryxAPI.Net.dll
- AlteryxDocument.dll
- Base.Net.dll
- FlxComm64.dll
- FlxConnect64.dll
- FlxCore64.dll