APIs

	Extension	Automation & Integration
NeoLoad Controller	Javascript API: Extend Virtual User Path with Javascript. Data Format Extension: Decode and encode formatted data that is exchanged between the client and the server. Custom Action API: Extend Virtual User Path with custom Advanced Actions. Data Exchange API: Add external metrics to NeoLoad results.	Design API: Automate a recording, manipulate projects. Runtime API: Start/Stop a load test from NeoLoad Controller. Results API: Generate and download reports.
NeoLoad Web		Results API: Retrieve/Push metrics for a test. Runtime API: Execute a test from NeoLoad Web. WebHooks: Execute actions on test eve.nts

Example and uses cases

• Converting a browser-based functional script to NeoLoad.

  For example, the NeoLoad Selenium driver uses the NeoLoad Controller Design API to initiate the recording and insert Transactions while the selenium script is played.

• Collecting End User Experience metrics from a real browser.

  For example, the NeoLoad Selenium driver uses the NeoLoad Controller Data Exchange API to send the metrics coming from the Browser’s Navigation Timing API to NeoLoad.

• Exchanging data with an APM tool.

  For example, the Dynatrace action uses:

  • The Custom Action API to add a "DynaTrace" action to NeoLoad Advanced Actions.

  • The Data Exchange API to inject APM data retrieved from Dynatrace into NeoLoad.

  • The NeoLoad Web Results API to extract and send NeoLoad data to Dynatrace.

• Encoding/Decoding formatted data. The goal is to convert binary or scrambled test to clear text, typically JSON or XML to extract/inject data from NeoLoad.

  For example, decoding the binary manifest of an HTTP Dynamic Streaming video so that the user can extract and then simulate the video stream from NeoLoad. See HDS Data Format Extension.

• Running performance tests under load.

  For example, Ranorex Integration relies on the Runtime API to:

  • Launch a NeoLoad test just before a set of functional test is triggered.

  • Increase the count of running VUs for each functional test iteration.

  • Stop the test when the functional tests have finished.