Welcome to SeleniumAPI, a streamlined utility for executing API calls directly from a Selenium driver. Designed with the needs of developers in mind, SeleniumAPI provides a solution for enhancing API interactions within a browser context.
Discover the unique benefits and innovative applications of SeleniumAPI:
1. Advanced Website Testing & Validation
SeleniumAPI allows you to make API calls on-the-go during your Selenium test sessions. This functionality provides the ability to cross-verify server responses with website UI, elevating the accuracy of your end-to-end testing.
2. Comprehensive User Experience Simulation
Recreate detailed user interactions that integrate UI manipulation and API calls. SeleniumAPI provides an accurate representation of user-triggered API calls, generating realistic data for improved UX analysis.
3. Streamlined Automation & Web Scraping
Enhance your data extraction processes by reaching application-specific data, usually hidden behind API calls, directly from your Selenium driver. Broaden the scope of your web scraping tasks by accessing dynamic data that might be unavailable through the page source.
4. Optimal Proxy Usage
Leverage your Selenium WebDriver's proxy settings during API interactions. This feature proves particularly useful for maintaining IP rotation during extensive web scraping operations or managing region-specific API responses.
5. Intelligent Rate Limiting Management
SeleniumAPI facilitates the handling of rate-limited APIs within the browsing context. By interspersing API requests with regular browser activity, it offers a sophisticated approach to managing request quotas.
SeleniumAPI seeks to redefine the boundaries of Selenium and API interaction by offering a solution tailored to the needs of today's developers. Step forward into a more dynamic browsing experience with SeleniumAPI.
Follow these simple steps to install SeleniumAPI and start executing API calls directly from a Selenium driver:
-
Clone the Repository
git clone https://github.com/TonyGlezx/seleniumapi
-
Navigate to the Project Directory
cd seleniumapi -
Create a Virtual Environment (Optional but Recommended)
python3 -m venv .venv source .venv/bin/activate # On Windows use `.venv\Scripts\activate`
-
Install the Package
pip install .
Now, you're ready to use SeleniumAPI in your projects!
To import and use the SeleniumAPI class in your own scripts, use:
from SeleniumAPI import SeleniumAPIThe following examples demonstrate some of the innovative ways you can leverage SeleniumAPI in your projects:
You can use SeleniumAPI to make API calls while navigating a website, and cross-check the server's responses against the UI elements:
from SeleniumAPI import SeleniumAPI
from selenium import webdriver
driver = webdriver.Firefox()
api = SeleniumAPI(driver)
response = api.call("https://api.example.com/data", method="GET")
# Now, compare the response with a UI element
element = driver.find_element_by_id("data-element")
assert element.text == response["data"]Perform detailed user interaction simulations that combine UI manipulation and API calls. Accurately mimic user-triggered API calls and collect user behavior data for UX analysis. Here's a simple demonstration of how you can achieve this with SeleniumAPI:
from SeleniumAPI import SeleniumAPI
from selenium import webdriver
driver = webdriver.Firefox()
api = SeleniumAPI(driver)
# Navigate to the site and simulate user behavior
driver.get("https://www.example.com")
driver.find_element_by_id('submit_button').click()
# Perform the API call and collect data for UX analysis
response = api.call("https://api.example.com", method="POST", payload={"user_action": "click"})- Handling non-json responses better
- Test case
- More Debug options
- Timeout management
- Improve performance with retry logic, long running operations and concurrency
- Return the full xhr object no matter the server response. Make it optional.
- Handle bad responses from POST calls with missing or malformed payloads.