Custom Connector
Zenscrape Connector
Global
The Zenscrape Connector facilitates seamless integration with the Zenscrape API, providing web-scraping capabilities for rendering web pages and checking API request limits. It acts as a proxy supporting actions for checking remaining requests and scraping web content with customizable parameters.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Zenscrape Connector.
- getStatus. Retrieves the number of remaining API requests for the provided API key.
- getScrape. Retrieves rendered web page content for a specified URL with customizable scraping options (GET).
- postScrape. Sends a POST request to scrape a specified URL with form data (POST).
Documentation
Detailed Integration Documentation
Status Retrieval
| Action | getStatus |
|---|---|
| Purpose | Retrieves the number of remaining API requests available for the provided API key. The primary entry point for monitoring API usage. |
| Parameters | Required: apiKey – your API key (register at app.zenscrape.com). Optional: None. |
| Configuration | Configure the base URL via CONNECTOR_ENV_ZENSCRAPE_BASE_URL (default https://app.zenscrape.com). |
| Output | Successful: JSON with result (success) and remaining_requests (integer). Failure: error details (invalid-api-key). |
| Workflow example | Execute getStatus with apiKey and process the response to monitor remaining API requests for usage tracking. |
Web Content Scraping (GET)
| Action | getScrape |
|---|---|
| Purpose | Retrieves rendered web page content for a specified URL, with options for premium proxies, location, rendering, and scrolling. |
| Parameters | Required: apiKey, url. Optional: premium (boolean), location (e.g. US), render (boolean), scroll_to_bottom (boolean). |
| Configuration | Configure the connector with the correct base URL. |
| Output | Successful: JSON with result, args, data, form, headers, method (GET), origin, resolved url, plus response headers including X-Zenscrape-RateLimit-Remaining. Failure: error details (invalid-url or invalid-api-key). |
| Workflow example | Execute getScrape with apiKey, url, and optional parameters like premium=true or render=true, then extract scraped content for analysis. |
Web Content Scraping (POST)
| Action | postScrape |
|---|---|
| Purpose | Sends a POST request to scrape a specified URL with form data, allowing dynamic web interactions. |
| Parameters | Required: apiKey, url. Optional: Form data – key-value pairs (e.g. key=value, key_2=value_2). |
| Configuration | Configure the connector with the correct base URL. |
| Output | Successful: JSON with result, args, data, form (submitted data), headers, method (POST), origin, resolved url. Failure: error details (invalid-url or invalid-api-key). |
| Workflow example | Execute postScrape with apiKey, url, and form data, then use the result for dynamic web interactions or data extraction. |
Example Workflow: Web Scraping and API Usage Monitoring
| Check API usage | Use getStatus with apiKey to fetch remaining API requests and ensure sufficient quota for scraping tasks. |
|---|---|
| Scrape content (GET) | Execute getScrape with apiKey, url, and optional parameters (premium, location, render, scroll_to_bottom), then extract content. |
| Scrape with form data (POST) | Execute postScrape with apiKey, url, and form data for dynamic web interactions or form validation. |
| Integrate scraped data | Combine GET and POST results for comprehensive analysis and integrate into dashboards or reporting tools. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.