API Reference Manuals
Eggplant Performance offers extensive APIs, whether you are creating Virtual User scripts or driving Eggplant Performance test execution remotely via REST API calls. Links to the documentation for the various APIs can be found on this page.
Virtual User API
Virtual User scripts are the main way to inject load and measure performance while testing with Eggplant Performance. Some scripts can be generated automatically from recordings or service definitions, but it is often helpful to edit the script code yourself.
Virtual User scripts are subclasses of VirtualUserScript, which means that you can call any of the VirtualUserScript API methods from within your script code. Different Virtual User types will also have extra API methods to make it easy to implement and modify their functionality - e.g. Web Virtual Users have extra API methods for sending HTTP requests, connecting to Websockets and verifying server responses, among many other things.
You will usually need to use only one set of Virtual User API documentation, depending on the Virtual User type and scripting language.
Java Virtual User API
As well as the standard VirtualUserScript API methods, this documentation includes information about these Virtual User types:
- Web Java Virtual User
- Eggplant Functional Java Virtual User
- Selenium Java Virtual User
Read the Java Virtual User API documentation here
C#/.NET Virtual User API
As well as the standard VirtualUserScript API methods, this documentation includes information about these Virtual User types:
- Web C# Virtual User
- Citrix C# Virtual User
- ASP.NET C# Virtual User
Read the C#/.NET Virtual User API documentation here
The WinDriver C# Virtual User documentation is part of this main user guide.
C++ IP API
This documentation includes information about the TCP/UDP C++ Virtual User.
Read the C++ IP Virtual User API documentation here
REST API
It can be useful to perform certain actions in Eggplant Performance automatically, such as starting a test run, or analyzing test results. A good example of this is using CI/CD to schedule automatic tests.
All three of the main components of Eggplant Performance have a REST API: