Update API documentation for version 0.10.3

Author: jjsaunier

docs/scrapfly/api_response.html

@@ -611,7 +611,7 @@ <h3>Inherited members</h3>
             _secrets = set()
 
             for signing_secret in signing_secrets:
-                _secrets.add(binascii.unhexlify(signing_secret))
+                _secrets.add(signing_secret.encode(&#39;utf-8&#39;))
 
             self._signing_secret = tuple(_secrets)
 
@@ -637,7 +637,18 @@ <h3>Inherited members</h3>
 
     def verify(self, message: bytes, signature: str) -&gt; bool:
         for signing_secret in self._signing_secret:
-            if hmac.new(signing_secret, message, hashlib.sha256).hexdigest().upper() == signature:
+            computed = hmac.new(signing_secret, message, hashlib.sha256).hexdigest().upper()
+            logger.debug(
+                &#39;WEBHOOK_VERIFY_DEBUG key_len=%d key_sha=%s body_len=%d body_sha=%s computed=%s received=%s match=%s&#39;,
+                len(signing_secret),
+                hashlib.sha256(signing_secret).hexdigest()[:16],
+                len(message),
+                hashlib.sha256(message).hexdigest()[:16],
+                computed,
+                signature,
+                computed == signature,
+            )
+            if computed == signature:
                 return True
 
         return False
@@ -819,7 +830,18 @@ <h3>Methods</h3>
 </summary>
 <pre><code class="python">def verify(self, message: bytes, signature: str) -&gt; bool:
     for signing_secret in self._signing_secret:
-        if hmac.new(signing_secret, message, hashlib.sha256).hexdigest().upper() == signature:
+        computed = hmac.new(signing_secret, message, hashlib.sha256).hexdigest().upper()
+        logger.debug(
+            &#39;WEBHOOK_VERIFY_DEBUG key_len=%d key_sha=%s body_len=%d body_sha=%s computed=%s received=%s match=%s&#39;,
+            len(signing_secret),
+            hashlib.sha256(signing_secret).hexdigest()[:16],
+            len(message),
+            hashlib.sha256(message).hexdigest()[:16],
+            computed,
+            signature,
+            computed == signature,
+        )
+        if computed == signature:
             return True
 
     return False</code></pre>

docs/scrapfly/browser_config.html

@@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="scrapfly.browser_config.BrowserConfig"><code class="flex name class">
 <span>class <span class="ident">BrowserConfig</span></span>
-<span>(</span><span>proxy_pool: str | <a title="scrapfly.browser_config.ProxyPool" href="#scrapfly.browser_config.ProxyPool">ProxyPool</a> | None = None,<br>os: str | <a title="scrapfly.browser_config.OperatingSystem" href="#scrapfly.browser_config.OperatingSystem">OperatingSystem</a> | None = None,<br>session: str | None = None,<br>country: str | None = None,<br>auto_close: bool | None = None,<br>timeout: int | None = None,<br>debug: bool | None = None,<br>extensions: List[str] | None = None,<br>block_images: bool | None = None,<br>block_styles: bool | None = None,<br>block_fonts: bool | None = None,<br>block_media: bool | None = None,<br>screenshot: bool | None = None,<br>resolution: str | None = None,<br>target_url: str | None = None,<br>cache: bool | None = None,<br>blacklist: bool | None = None,<br>unblock: bool | None = None,<br>unblock_timeout: int | None = None,<br>browser_brand: str | None = None,<br>byop_proxy: str | None = None,<br>enable_mcp: bool | None = None)</span>
+<span>(</span><span>proxy_pool: str | <a title="scrapfly.browser_config.ProxyPool" href="#scrapfly.browser_config.ProxyPool">ProxyPool</a> | None = None,<br>os: str | <a title="scrapfly.browser_config.OperatingSystem" href="#scrapfly.browser_config.OperatingSystem">OperatingSystem</a> | None = None,<br>session: str | None = None,<br>country: str | None = None,<br>auto_close: bool | None = None,<br>timeout: int | None = None,<br>debug: bool | None = None,<br>extensions: List[str] | None = None,<br>block_images: bool | None = None,<br>block_styles: bool | None = None,<br>block_fonts: bool | None = None,<br>block_media: bool | None = None,<br>screenshot: bool | None = None,<br>resolution: str | None = None,<br>target_url: str | None = None,<br>cache: bool | None = None,<br>blacklist: bool | None = None,<br>unblock: bool | None = None,<br>unblock_timeout: int | None = None,<br>browser_brand: str | None = None,<br>byop_proxy: str | None = None,<br>enable_mcp: bool | None = None,<br>solve_captcha: bool | None = None)</span>
 </code></dt>
 <dd>
 <details class="source">
@@ -83,6 +83,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         browser_brand: Optional[str] = None,
         byop_proxy: Optional[str] = None,
         enable_mcp: Optional[bool] = None,
+        solve_captcha: Optional[bool] = None,
     ):
         if timeout is not None and timeout &gt; 1800:
             raise ValueError(&#39;timeout cannot exceed 1800 seconds (30 minutes)&#39;)
@@ -122,6 +123,12 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         # https://scrapfly.io/docs/cloud-browser-api/byop
         self.byop_proxy = byop_proxy
         self.enable_mcp = enable_mcp
+        # SolveCaptcha: arm Scrapium&#39;s built-in captcha detector + solver on
+        # the first page attach. Turnstile, DataDome slider, reCAPTCHA,
+        # GeeTest, PerimeterX hold, and puzzle captchas are handled
+        # automatically. Billed per solve; failures cost nothing.
+        # https://scrapfly.io/docs/cloud-browser-api/captcha-solver
+        self.solve_captcha = solve_captcha
 
     def websocket_url(self, api_key: str, host: Optional[str] = None) -&gt; str:
         params = {&#39;api_key&#39;: api_key}
@@ -192,6 +199,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         if self.enable_mcp is not None:
             params[&#39;enable_mcp&#39;] = self._bool_to_http(self.enable_mcp)
 
+        if self.solve_captcha is not None:
+            params[&#39;solve_captcha&#39;] = self._bool_to_http(self.solve_captcha)
+
         base_host = host or self.CLOUD_BROWSER_HOST
         return base_host + &#39;?&#39; + urlencode(params)
 
@@ -219,6 +229,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             &#39;browser_brand&#39;: self.browser_brand,
             &#39;byop_proxy&#39;: self.byop_proxy,
             &#39;enable_mcp&#39;: self.enable_mcp,
+            &#39;solve_captcha&#39;: self.solve_captcha,
         }
 
     @staticmethod
@@ -254,6 +265,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             browser_brand=browser_config_dict.get(&#39;browser_brand&#39;, None),
             byop_proxy=browser_config_dict.get(&#39;byop_proxy&#39;, None),
             enable_mcp=browser_config_dict.get(&#39;enable_mcp&#39;, None),
+            solve_captcha=browser_config_dict.get(&#39;solve_captcha&#39;, None),
         )</code></pre>
 </details>
 <div class="desc"></div>
@@ -311,6 +323,7 @@ <h3>Static methods</h3>
         browser_brand=browser_config_dict.get(&#39;browser_brand&#39;, None),
         byop_proxy=browser_config_dict.get(&#39;byop_proxy&#39;, None),
         enable_mcp=browser_config_dict.get(&#39;enable_mcp&#39;, None),
+        solve_captcha=browser_config_dict.get(&#39;solve_captcha&#39;, None),
     )</code></pre>
 </details>
 <div class="desc"></div>
@@ -350,6 +363,7 @@ <h3>Methods</h3>
         &#39;browser_brand&#39;: self.browser_brand,
         &#39;byop_proxy&#39;: self.byop_proxy,
         &#39;enable_mcp&#39;: self.enable_mcp,
+        &#39;solve_captcha&#39;: self.solve_captcha,
     }</code></pre>
 </details>
 <div class="desc"></div>
@@ -431,6 +445,9 @@ <h3>Methods</h3>
     if self.enable_mcp is not None:
         params[&#39;enable_mcp&#39;] = self._bool_to_http(self.enable_mcp)
 
+    if self.solve_captcha is not None:
+        params[&#39;solve_captcha&#39;] = self._bool_to_http(self.solve_captcha)
+
     base_host = host or self.CLOUD_BROWSER_HOST
     return base_host + &#39;?&#39; + urlencode(params)</code></pre>
 </details>

docs/scrapfly/client.html

@@ -123,7 +123,7 @@ <h3>Class variables</h3>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">class ScrapflyClient:
+<pre><code class="python">class ScrapflyClient(ScheduleClientMixin):
 
     HOST = &#39;https://api.scrapfly.io&#39;
     CLOUD_BROWSER_HOST = &#39;wss://browser.scrapfly.io&#39;
@@ -1674,6 +1674,7 @@ <h3>Class variables</h3>
         body: Optional[str] = None,
         method: Optional[str] = None,
         enable_mcp: Optional[bool] = None,
+        solve_captcha: Optional[bool] = None,
     ) -&gt; Dict:
         &#34;&#34;&#34;
         Bypass anti-bot protection and get a ready-to-use browser session.
@@ -1722,6 +1723,9 @@ <h3>Class variables</h3>
         if enable_mcp is not None:
             json_body[&#39;enable_mcp&#39;] = enable_mcp
 
+        if solve_captcha is not None:
+            json_body[&#39;solve_captcha&#39;] = solve_captcha
+
         response = self._http_handler(
             method=&#39;POST&#39;,
             url=self.cloud_browser_api_host + &#39;/unblock&#39;,
@@ -1931,7 +1935,14 @@ <h3>Class variables</h3>
         response.raise_for_status()
         return response.json()</code></pre>
 </details>
-<div class="desc"></div>
+<div class="desc"><p>Mixed into ScrapflyClient — provides the public schedule surface.</p>
+<p>All methods funnel through <code>_schedule_request</code>, which uses the same
+<code>self._http_handler</code> and <code>self.host</code> / <code>self.key</code> as the rest of the
+client so retries, verify, headers and timeouts behave identically.</p></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="scrapfly.schedule.ScheduleClientMixin" href="schedule.html#scrapfly.schedule.ScheduleClientMixin">ScheduleClientMixin</a></li>
+</ul>
 <h3>Class variables</h3>
 <dl>
 <dt id="scrapfly.client.ScrapflyClient.CLOUD_BROWSER_API_HOST"><code class="name">var <span class="ident">CLOUD_BROWSER_API_HOST</span></code></dt>
@@ -2577,7 +2588,7 @@ <h2 id="example">Example</h2>
 :return: dict with 'sessions' list and 'total' count</p></div>
 </dd>
 <dt id="scrapfly.client.ScrapflyClient.cloud_browser_unblock"><code class="name flex">
-<span>def <span class="ident">cloud_browser_unblock</span></span>(<span>self,<br>url: str,<br>proxy_pool: str | None = None,<br>country: str | None = None,<br>os: str | None = None,<br>timeout: int | None = None,<br>browser_timeout: int | None = None,<br>headers: Dict | None = None,<br>body: str | None = None,<br>method: str | None = None,<br>enable_mcp: bool | None = None) ‑> Dict</span>
+<span>def <span class="ident">cloud_browser_unblock</span></span>(<span>self,<br>url: str,<br>proxy_pool: str | None = None,<br>country: str | None = None,<br>os: str | None = None,<br>timeout: int | None = None,<br>browser_timeout: int | None = None,<br>headers: Dict | None = None,<br>body: str | None = None,<br>method: str | None = None,<br>enable_mcp: bool | None = None,<br>solve_captcha: bool | None = None) ‑> Dict</span>
 </code></dt>
 <dd>
 <details class="source">
@@ -2596,6 +2607,7 @@ <h2 id="example">Example</h2>
     body: Optional[str] = None,
     method: Optional[str] = None,
     enable_mcp: Optional[bool] = None,
+    solve_captcha: Optional[bool] = None,
 ) -&gt; Dict:
     &#34;&#34;&#34;
     Bypass anti-bot protection and get a ready-to-use browser session.
@@ -2644,6 +2656,9 @@ <h2 id="example">Example</h2>
     if enable_mcp is not None:
         json_body[&#39;enable_mcp&#39;] = enable_mcp
 
+    if solve_captcha is not None:
+        json_body[&#39;solve_captcha&#39;] = solve_captcha
+
     response = self._http_handler(
         method=&#39;POST&#39;,
         url=self.cloud_browser_api_host + &#39;/unblock&#39;,
@@ -3973,6 +3988,21 @@ <h2 id="example">Example</h2>
 </code></pre></div>
 </dd>
 </dl>
+<h3>Inherited members</h3>
+<ul class="hlist">
+<li><code><b><a title="scrapfly.schedule.ScheduleClientMixin" href="schedule.html#scrapfly.schedule.ScheduleClientMixin">ScheduleClientMixin</a></b></code>:
+<ul class="hlist">
+<li><code><a title="scrapfly.schedule.ScheduleClientMixin.cancel_schedule" href="schedule.html#scrapfly.schedule.ScheduleClientMixin.cancel_schedule">cancel_schedule</a></code></li>
+<li><code><a title="scrapfly.schedule.ScheduleClientMixin.create_crawler_schedule" href="schedule.html#scrapfly.schedule.ScheduleClientMixin.create_crawler_schedule">create_crawler_schedule</a></code></li>
+<li><code><a title="scrapfly.schedule.ScheduleClientMixin.create_scrape_schedule" href="schedule.html#scrapfly.schedule.ScheduleClientMixin.create_scrape_schedule">create_scrape_schedule</a></code></li>
+<li><code><a title="scrapfly.schedule.ScheduleClientMixin.create_screenshot_schedule" href="schedule.html#scrapfly.schedule.ScheduleClientMixin.create_screenshot_schedule">create_screenshot_schedule</a></code></li>
+<li><code><a title="scrapfly.schedule.ScheduleClientMixin.execute_schedule" href="schedule.html#scrapfly.schedule.ScheduleClientMixin.execute_schedule">execute_schedule</a></code></li>
+<li><code><a title="scrapfly.schedule.ScheduleClientMixin.get_schedule" href="schedule.html#scrapfly.schedule.ScheduleClientMixin.get_schedule">get_schedule</a></code></li>
+<li><code><a title="scrapfly.schedule.ScheduleClientMixin.list_schedules" href="schedule.html#scrapfly.schedule.ScheduleClientMixin.list_schedules">list_schedules</a></code></li>
+<li><code><a title="scrapfly.schedule.ScheduleClientMixin.update_schedule" href="schedule.html#scrapfly.schedule.ScheduleClientMixin.update_schedule">update_schedule</a></code></li>
+</ul>
+</li>
+</ul>
 </dd>
 </dl>
 </section>

docs/scrapfly/crawler/crawler_webhook.html

@@ -90,8 +90,9 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     Args:
         payload: The full webhook body as a dict (i.e. what you get from
             ``request.json``).
-        signing_secrets: Optional tuple of signing secrets (hex strings) for
-            signature verification.
+        signing_secrets: Optional tuple of signing secrets for signature
+            verification. Pass each secret as it appears in the webhook
+            dashboard (UTF-8 string, not hex-encoded).
         signature: Optional webhook signature header value
             (``X-Scrapfly-Webhook-Signature``).
 
@@ -111,7 +112,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         ... def handle_webhook():
         ...     wh = webhook_from_payload(
         ...         request.json,
-        ...         signing_secrets=(&#39;your-secret-hex&#39;,),
+        ...         signing_secrets=(&#39;YOUR-WEBHOOK-SIGNING-SECRET&#39;,),
         ...         signature=request.headers.get(&#39;X-Scrapfly-Webhook-Signature&#39;),
         ...     )
         ...     if isinstance(wh, CrawlerLifecycleWebhook) and wh.event == &#39;crawler_finished&#39;:
@@ -151,8 +152,9 @@ <h2 id="args">Args</h2>
 <dd>The full webhook body as a dict (i.e. what you get from
 <code>request.json</code>).</dd>
 <dt><strong><code>signing_secrets</code></strong></dt>
-<dd>Optional tuple of signing secrets (hex strings) for
-signature verification.</dd>
+<dd>Optional tuple of signing secrets for signature
+verification. Pass each secret as it appears in the webhook
+dashboard (UTF-8 string, not hex-encoded).</dd>
 <dt><strong><code>signature</code></strong></dt>
 <dd>Optional webhook signature header value
 (<code>X-Scrapfly-Webhook-Signature</code>).</dd>
@@ -176,7 +178,7 @@ <h2 id="example">Example</h2>
 ... def handle_webhook():
 ...     wh = webhook_from_payload(
 ...         request.json,
-...         signing_secrets=('your-secret-hex',),
+...         signing_secrets=('YOUR-WEBHOOK-SIGNING-SECRET',),
 ...         signature=request.headers.get('X-Scrapfly-Webhook-Signature'),
 ...     )
 ...     if isinstance(wh, CrawlerLifecycleWebhook) and wh.event == 'crawler_finished':

docs/scrapfly/crawler/index.html

@@ -155,8 +155,9 @@ <h2 id="example">Example</h2>
     Args:
         payload: The full webhook body as a dict (i.e. what you get from
             ``request.json``).
-        signing_secrets: Optional tuple of signing secrets (hex strings) for
-            signature verification.
+        signing_secrets: Optional tuple of signing secrets for signature
+            verification. Pass each secret as it appears in the webhook
+            dashboard (UTF-8 string, not hex-encoded).
         signature: Optional webhook signature header value
             (``X-Scrapfly-Webhook-Signature``).
 
@@ -176,7 +177,7 @@ <h2 id="example">Example</h2>
         ... def handle_webhook():
         ...     wh = webhook_from_payload(
         ...         request.json,
-        ...         signing_secrets=(&#39;your-secret-hex&#39;,),
+        ...         signing_secrets=(&#39;YOUR-WEBHOOK-SIGNING-SECRET&#39;,),
         ...         signature=request.headers.get(&#39;X-Scrapfly-Webhook-Signature&#39;),
         ...     )
         ...     if isinstance(wh, CrawlerLifecycleWebhook) and wh.event == &#39;crawler_finished&#39;:
@@ -216,8 +217,9 @@ <h2 id="args">Args</h2>
 <dd>The full webhook body as a dict (i.e. what you get from
 <code>request.json</code>).</dd>
 <dt><strong><code>signing_secrets</code></strong></dt>
-<dd>Optional tuple of signing secrets (hex strings) for
-signature verification.</dd>
+<dd>Optional tuple of signing secrets for signature
+verification. Pass each secret as it appears in the webhook
+dashboard (UTF-8 string, not hex-encoded).</dd>
 <dt><strong><code>signature</code></strong></dt>
 <dd>Optional webhook signature header value
 (<code>X-Scrapfly-Webhook-Signature</code>).</dd>
@@ -241,7 +243,7 @@ <h2 id="example">Example</h2>
 ... def handle_webhook():
 ...     wh = webhook_from_payload(
 ...         request.json,
-...         signing_secrets=('your-secret-hex',),
+...         signing_secrets=('YOUR-WEBHOOK-SIGNING-SECRET',),
 ...         signature=request.headers.get('X-Scrapfly-Webhook-Signature'),
 ...     )
 ...     if isinstance(wh, CrawlerLifecycleWebhook) and wh.event == 'crawler_finished':