Captura de ecrã síncrona

POST

screenshot

curl --request POST \
  --url https://screenshot.cleariflow.com/v1/screenshot \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "api_key": "<string>",
  "session_id": "<string>",
  "fingerprint": "<string>",
  "render": {},
  "render.wait_until": "<string>",
  "render.timeout_ms": 123,
  "render.post_load_wait_ms": 123,
  "render.ignore_https_errors": true,
  "render.full_page": true,
  "render.screenshot_format": "<string>",
  "render.user_agent": "<string>",
  "render.viewport": {},
  "resources": {},
  "resources.block": [
    {}
  ],
  "actions": [
    {}
  ],
  "actions[].type": "<string>",
  "actions[].selector": "<string>",
  "actions[].text": "<string>",
  "actions[].css": "<string>",
  "actions[].to": "<string>",
  "actions[].wait_ms": 123,
  "cookies": [
    {}
  ],
  "capture_full_page": true,
  "width": 123,
  "height": 123,
  "delay": 123,
  "css_injection": "<string>",
  "export_format": "<string>"
}
'

import requests

url = "https://screenshot.cleariflow.com/v1/screenshot"

payload = {
    "url": "<string>",
    "api_key": "<string>",
    "session_id": "<string>",
    "fingerprint": "<string>",
    "render": {},
    "render.wait_until": "<string>",
    "render.timeout_ms": 123,
    "render.post_load_wait_ms": 123,
    "render.ignore_https_errors": True,
    "render.full_page": True,
    "render.screenshot_format": "<string>",
    "render.user_agent": "<string>",
    "render.viewport": {},
    "resources": {},
    "resources.block": [{}],
    "actions": [{}],
    "actions[].type": "<string>",
    "actions[].selector": "<string>",
    "actions[].text": "<string>",
    "actions[].css": "<string>",
    "actions[].to": "<string>",
    "actions[].wait_ms": 123,
    "cookies": [{}],
    "capture_full_page": True,
    "width": 123,
    "height": 123,
    "delay": 123,
    "css_injection": "<string>",
    "export_format": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    api_key: '<string>',
    session_id: '<string>',
    fingerprint: '<string>',
    render: {},
    'render.wait_until': '<string>',
    'render.timeout_ms': 123,
    'render.post_load_wait_ms': 123,
    'render.ignore_https_errors': true,
    'render.full_page': true,
    'render.screenshot_format': '<string>',
    'render.user_agent': '<string>',
    'render.viewport': {},
    resources: {},
    'resources.block': [{}],
    actions: [{}],
    'actions[].type': '<string>',
    'actions[].selector': '<string>',
    'actions[].text': '<string>',
    'actions[].css': '<string>',
    'actions[].to': '<string>',
    'actions[].wait_ms': 123,
    cookies: [{}],
    capture_full_page: true,
    width: 123,
    height: 123,
    delay: 123,
    css_injection: '<string>',
    export_format: '<string>'
  })
};

fetch('https://screenshot.cleariflow.com/v1/screenshot', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://screenshot.cleariflow.com/v1/screenshot",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'api_key' => '<string>',
    'session_id' => '<string>',
    'fingerprint' => '<string>',
    'render' => [
        
    ],
    'render.wait_until' => '<string>',
    'render.timeout_ms' => 123,
    'render.post_load_wait_ms' => 123,
    'render.ignore_https_errors' => true,
    'render.full_page' => true,
    'render.screenshot_format' => '<string>',
    'render.user_agent' => '<string>',
    'render.viewport' => [
        
    ],
    'resources' => [
        
    ],
    'resources.block' => [
        [
                
        ]
    ],
    'actions' => [
        [
                
        ]
    ],
    'actions[].type' => '<string>',
    'actions[].selector' => '<string>',
    'actions[].text' => '<string>',
    'actions[].css' => '<string>',
    'actions[].to' => '<string>',
    'actions[].wait_ms' => 123,
    'cookies' => [
        [
                
        ]
    ],
    'capture_full_page' => true,
    'width' => 123,
    'height' => 123,
    'delay' => 123,
    'css_injection' => '<string>',
    'export_format' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://screenshot.cleariflow.com/v1/screenshot"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"fingerprint\": \"<string>\",\n  \"render\": {},\n  \"render.wait_until\": \"<string>\",\n  \"render.timeout_ms\": 123,\n  \"render.post_load_wait_ms\": 123,\n  \"render.ignore_https_errors\": true,\n  \"render.full_page\": true,\n  \"render.screenshot_format\": \"<string>\",\n  \"render.user_agent\": \"<string>\",\n  \"render.viewport\": {},\n  \"resources\": {},\n  \"resources.block\": [\n    {}\n  ],\n  \"actions\": [\n    {}\n  ],\n  \"actions[].type\": \"<string>\",\n  \"actions[].selector\": \"<string>\",\n  \"actions[].text\": \"<string>\",\n  \"actions[].css\": \"<string>\",\n  \"actions[].to\": \"<string>\",\n  \"actions[].wait_ms\": 123,\n  \"cookies\": [\n    {}\n  ],\n  \"capture_full_page\": true,\n  \"width\": 123,\n  \"height\": 123,\n  \"delay\": 123,\n  \"css_injection\": \"<string>\",\n  \"export_format\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://screenshot.cleariflow.com/v1/screenshot")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"fingerprint\": \"<string>\",\n  \"render\": {},\n  \"render.wait_until\": \"<string>\",\n  \"render.timeout_ms\": 123,\n  \"render.post_load_wait_ms\": 123,\n  \"render.ignore_https_errors\": true,\n  \"render.full_page\": true,\n  \"render.screenshot_format\": \"<string>\",\n  \"render.user_agent\": \"<string>\",\n  \"render.viewport\": {},\n  \"resources\": {},\n  \"resources.block\": [\n    {}\n  ],\n  \"actions\": [\n    {}\n  ],\n  \"actions[].type\": \"<string>\",\n  \"actions[].selector\": \"<string>\",\n  \"actions[].text\": \"<string>\",\n  \"actions[].css\": \"<string>\",\n  \"actions[].to\": \"<string>\",\n  \"actions[].wait_ms\": 123,\n  \"cookies\": [\n    {}\n  ],\n  \"capture_full_page\": true,\n  \"width\": 123,\n  \"height\": 123,\n  \"delay\": 123,\n  \"css_injection\": \"<string>\",\n  \"export_format\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://screenshot.cleariflow.com/v1/screenshot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"fingerprint\": \"<string>\",\n  \"render\": {},\n  \"render.wait_until\": \"<string>\",\n  \"render.timeout_ms\": 123,\n  \"render.post_load_wait_ms\": 123,\n  \"render.ignore_https_errors\": true,\n  \"render.full_page\": true,\n  \"render.screenshot_format\": \"<string>\",\n  \"render.user_agent\": \"<string>\",\n  \"render.viewport\": {},\n  \"resources\": {},\n  \"resources.block\": [\n    {}\n  ],\n  \"actions\": [\n    {}\n  ],\n  \"actions[].type\": \"<string>\",\n  \"actions[].selector\": \"<string>\",\n  \"actions[].text\": \"<string>\",\n  \"actions[].css\": \"<string>\",\n  \"actions[].to\": \"<string>\",\n  \"actions[].wait_ms\": 123,\n  \"cookies\": [\n    {}\n  ],\n  \"capture_full_page\": true,\n  \"width\": 123,\n  \"height\": 123,\n  \"delay\": 123,\n  \"css_injection\": \"<string>\",\n  \"export_format\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "image_base64": "/9j/4AAQSkZJRg...",
  "content_type": "image/jpeg",
  "meta": {
    "elapsed_ms": 4521
  }
}

Primeiros passos

URL base

https://screenshot.cleariflow.com/v1/screenshot

Exemplo de pedido

curl -X POST 'https://screenshot.cleariflow.com/v1/screenshot' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "YOUR_UNIQUE_API_KEY",
    "url": "https://cleariflow.com",
    "capture_full_page": true,
    "export_format": "jpeg"
  }'

Um pedido bem-sucedido devolve a captura de ecrã em base64 e metadados:

{
  "ok": true,
  "image_base64": "/9j/4AAQSkZJRg...",
  "content_type": "image/jpeg",
  "meta": {
    "elapsed_ms": 4521
  }
}

Descodifique image_base64 para obter os bytes JPEG ou PNG brutos.

Opções de renderização

O objeto render controla como o navegador carrega a página antes da captura. Todos os campos são opcionais — se omitidos, aplicam-se os valores predefinidos do servidor.

"render": {
  "wait_until": "networkidle",
  "timeout_ms": 60000,
  "post_load_wait_ms": 2000,
  "ignore_https_errors": false,
  "full_page": true,
  "screenshot_format": "jpeg",
  "user_agent": "Mozilla/5.0 ...",
  "viewport": {
    "width": 1365,
    "height": 768
  }
}

Campo	Tipo	Predefinição	Descrição
`wait_until`	String	`domcontentloaded`	Quando considerar a navegação concluída. Use `domcontentloaded` para resultados mais rápidos; use `networkidle` quando a página carrega dados via XHR/fetch após o HTML inicial.
`timeout_ms`	Integer	`60000`	Tempo máximo em milissegundos para aguardar o carregamento da página.
`post_load_wait_ms`	Integer	`0`	Atraso adicional em milissegundos após `wait_until` antes da captura. Útil para animações ou conteúdo lazy-loaded.
`ignore_https_errors`	Boolean	`false`	Se `true`, ignora erros de certificado TLS da página alvo.
`full_page`	Boolean	`true`	Se `true`, captura toda a altura deslocável da página.
`screenshot_format`	String	`jpeg`	Formato de saída: `jpeg` ou `png`.
`user_agent`	String	—	String User-Agent personalizada para a sessão do navegador.
`viewport`	Object	`1365×768`	Tamanho do viewport via `width` e `height` em píxeis.

Campos de conveniência

Estes campos de nível superior são aliases fundidos em render e actions para retrocompatibilidade e pedidos mais simples:

Campo	Mapeia para	Descrição
`capture_full_page`	`render.full_page`	Alternar captura de página completa.
`width` / `height`	`render.viewport`	Dimensões do viewport em píxeis.
`delay`	`render.post_load_wait_ms`	Atraso em segundos antes da captura.
`export_format`	`render.screenshot_format`	`jpeg` ou `png`.
`user_agent`	`render.user_agent`	User-Agent personalizado.
`css_injection`	ação `inject_css`	CSS injetado antes da captura quando não há ação `inject_css`.

Exemplo com campos planos:

curl -X POST 'https://screenshot.cleariflow.com/v1/screenshot' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "YOUR_UNIQUE_API_KEY",
    "url": "https://cleariflow.com",
    "width": 1280,
    "height": 720,
    "delay": 2,
    "export_format": "png"
  }'

Opções de recursos

O objeto resources controla que tipos de recursos o navegador carrega durante a captura. Bloquear recursos pesados acelera pedidos quando a fidelidade visual o permite.

"resources": {
  "block": ["images", "fonts", "media"]
}

Valor	Bloqueia
`images`	Imagens (`<img>`, fundos CSS)
`fonts`	Fontes web
`media`	Fluxos de vídeo e áudio

Endpoint GET legacy

GET /v1/ devolve bytes de imagem brutos (JPEG ou PNG) em vez de JSON. Passe os parâmetros como query strings:

https://screenshot.cleariflow.com/v1/?api_key=YOUR_UNIQUE_API_KEY&url=https://cleariflow.com&capture_full_page=true&export_format=jpeg

Parâmetros de consulta suportados: url, api_key, session_id, fingerprint, capture_full_page, width, height, delay, css_injection, user_agent, export_format.

Parâmetros de pedido

String

obrigatório

O URL alvo a capturar. Deve ser um URL HTTP ou HTTPS público. Pedidos a localhost e endereços IP privados são bloqueados pela proteção SSRF.

String

obrigatório

A sua chave API única.

String

Identificador de sessão opcional para reutilizar o estado do navegador (cookies, armazenamento local) entre múltiplos pedidos.

String

Preset de impressão digital do navegador. Valores suportados: desktop_en_us, desktop_ru_ru, mobile_en_us.

Object

Opções de renderização e captura para a sessão do navegador.

String

Quando considerar a navegação concluída. Valores: domcontentloaded, networkidle. Predefinição: domcontentloaded.

Integer

Tempo máximo em milissegundos para aguardar o carregamento da página. Predefinição: 60000.

Integer

Atraso adicional em milissegundos após o evento de carregamento da página antes da captura.

Boolean

Se true, ignora erros de certificado TLS da página alvo.

Boolean

Se true, captura toda a página deslocável. Predefinição: true.

String

Formato de saída: jpeg ou png. Predefinição: jpeg.

String

User-Agent personalizado para a sessão do navegador.

Object

Tamanho do viewport com width e height em píxeis.

Object

Controlos de carregamento de recursos.

Array

Tipos de recursos a bloquear. Valores suportados: images, fonts, media.

Array

Lista ordenada de ações do navegador antes da captura. Cada ação é um objeto com um campo type.

String

obrigatório

Tipo de ação. Valores suportados: wait, wait_for, click, type, scroll, inject_css.

String

Seletor CSS para ações wait_for, click ou type.

String

Texto a digitar para a ação type.

String

String CSS para a ação inject_css.

String

Destino de scroll para a ação scroll (ex.: bottom).

Integer

Duração em milissegundos para a ação wait.

Array

Cookies a injetar antes da navegação. Cada objeto cookie requer name e value; campos opcionais: domain, path.

Boolean

Alias de conveniência para render.full_page.

Integer

Alias de conveniência para render.viewport.width.

Integer

Alias de conveniência para render.viewport.height.

Integer

Atraso em segundos antes da captura. Mapeado para render.post_load_wait_ms.

String

CSS injetado via ação inject_css quando não está presente em actions.

String

Alias de conveniência para render.screenshot_format. Valores: jpeg, png.

Parâmetros de resposta

A resposta da API é devolvida num formato JSON universal e leve.

Boolean

Se a captura de ecrã foi concluída com sucesso.

String

Dados de imagem codificados em base64. Descodifique para obter bytes JPEG ou PNG brutos.

String

Tipo MIME da imagem (image/jpeg ou image/png).

Object

Metadados sobre a captura, incluindo o tempo decorrido em milissegundos.

Object

Detalhes do erro quando ok é false.

Captura de ecrã síncrona

curl --request POST \
  --url https://screenshot.cleariflow.com/v1/screenshot \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "api_key": "<string>",
  "session_id": "<string>",
  "fingerprint": "<string>",
  "render": {},
  "render.wait_until": "<string>",
  "render.timeout_ms": 123,
  "render.post_load_wait_ms": 123,
  "render.ignore_https_errors": true,
  "render.full_page": true,
  "render.screenshot_format": "<string>",
  "render.user_agent": "<string>",
  "render.viewport": {},
  "resources": {},
  "resources.block": [
    {}
  ],
  "actions": [
    {}
  ],
  "actions[].type": "<string>",
  "actions[].selector": "<string>",
  "actions[].text": "<string>",
  "actions[].css": "<string>",
  "actions[].to": "<string>",
  "actions[].wait_ms": 123,
  "cookies": [
    {}
  ],
  "capture_full_page": true,
  "width": 123,
  "height": 123,
  "delay": 123,
  "css_injection": "<string>",
  "export_format": "<string>"
}
'

import requests

url = "https://screenshot.cleariflow.com/v1/screenshot"

payload = {
    "url": "<string>",
    "api_key": "<string>",
    "session_id": "<string>",
    "fingerprint": "<string>",
    "render": {},
    "render.wait_until": "<string>",
    "render.timeout_ms": 123,
    "render.post_load_wait_ms": 123,
    "render.ignore_https_errors": True,
    "render.full_page": True,
    "render.screenshot_format": "<string>",
    "render.user_agent": "<string>",
    "render.viewport": {},
    "resources": {},
    "resources.block": [{}],
    "actions": [{}],
    "actions[].type": "<string>",
    "actions[].selector": "<string>",
    "actions[].text": "<string>",
    "actions[].css": "<string>",
    "actions[].to": "<string>",
    "actions[].wait_ms": 123,
    "cookies": [{}],
    "capture_full_page": True,
    "width": 123,
    "height": 123,
    "delay": 123,
    "css_injection": "<string>",
    "export_format": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    api_key: '<string>',
    session_id: '<string>',
    fingerprint: '<string>',
    render: {},
    'render.wait_until': '<string>',
    'render.timeout_ms': 123,
    'render.post_load_wait_ms': 123,
    'render.ignore_https_errors': true,
    'render.full_page': true,
    'render.screenshot_format': '<string>',
    'render.user_agent': '<string>',
    'render.viewport': {},
    resources: {},
    'resources.block': [{}],
    actions: [{}],
    'actions[].type': '<string>',
    'actions[].selector': '<string>',
    'actions[].text': '<string>',
    'actions[].css': '<string>',
    'actions[].to': '<string>',
    'actions[].wait_ms': 123,
    cookies: [{}],
    capture_full_page: true,
    width: 123,
    height: 123,
    delay: 123,
    css_injection: '<string>',
    export_format: '<string>'
  })
};

fetch('https://screenshot.cleariflow.com/v1/screenshot', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://screenshot.cleariflow.com/v1/screenshot",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'api_key' => '<string>',
    'session_id' => '<string>',
    'fingerprint' => '<string>',
    'render' => [
        
    ],
    'render.wait_until' => '<string>',
    'render.timeout_ms' => 123,
    'render.post_load_wait_ms' => 123,
    'render.ignore_https_errors' => true,
    'render.full_page' => true,
    'render.screenshot_format' => '<string>',
    'render.user_agent' => '<string>',
    'render.viewport' => [
        
    ],
    'resources' => [
        
    ],
    'resources.block' => [
        [
                
        ]
    ],
    'actions' => [
        [
                
        ]
    ],
    'actions[].type' => '<string>',
    'actions[].selector' => '<string>',
    'actions[].text' => '<string>',
    'actions[].css' => '<string>',
    'actions[].to' => '<string>',
    'actions[].wait_ms' => 123,
    'cookies' => [
        [
                
        ]
    ],
    'capture_full_page' => true,
    'width' => 123,
    'height' => 123,
    'delay' => 123,
    'css_injection' => '<string>',
    'export_format' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://screenshot.cleariflow.com/v1/screenshot"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"fingerprint\": \"<string>\",\n  \"render\": {},\n  \"render.wait_until\": \"<string>\",\n  \"render.timeout_ms\": 123,\n  \"render.post_load_wait_ms\": 123,\n  \"render.ignore_https_errors\": true,\n  \"render.full_page\": true,\n  \"render.screenshot_format\": \"<string>\",\n  \"render.user_agent\": \"<string>\",\n  \"render.viewport\": {},\n  \"resources\": {},\n  \"resources.block\": [\n    {}\n  ],\n  \"actions\": [\n    {}\n  ],\n  \"actions[].type\": \"<string>\",\n  \"actions[].selector\": \"<string>\",\n  \"actions[].text\": \"<string>\",\n  \"actions[].css\": \"<string>\",\n  \"actions[].to\": \"<string>\",\n  \"actions[].wait_ms\": 123,\n  \"cookies\": [\n    {}\n  ],\n  \"capture_full_page\": true,\n  \"width\": 123,\n  \"height\": 123,\n  \"delay\": 123,\n  \"css_injection\": \"<string>\",\n  \"export_format\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://screenshot.cleariflow.com/v1/screenshot")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"fingerprint\": \"<string>\",\n  \"render\": {},\n  \"render.wait_until\": \"<string>\",\n  \"render.timeout_ms\": 123,\n  \"render.post_load_wait_ms\": 123,\n  \"render.ignore_https_errors\": true,\n  \"render.full_page\": true,\n  \"render.screenshot_format\": \"<string>\",\n  \"render.user_agent\": \"<string>\",\n  \"render.viewport\": {},\n  \"resources\": {},\n  \"resources.block\": [\n    {}\n  ],\n  \"actions\": [\n    {}\n  ],\n  \"actions[].type\": \"<string>\",\n  \"actions[].selector\": \"<string>\",\n  \"actions[].text\": \"<string>\",\n  \"actions[].css\": \"<string>\",\n  \"actions[].to\": \"<string>\",\n  \"actions[].wait_ms\": 123,\n  \"cookies\": [\n    {}\n  ],\n  \"capture_full_page\": true,\n  \"width\": 123,\n  \"height\": 123,\n  \"delay\": 123,\n  \"css_injection\": \"<string>\",\n  \"export_format\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://screenshot.cleariflow.com/v1/screenshot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"fingerprint\": \"<string>\",\n  \"render\": {},\n  \"render.wait_until\": \"<string>\",\n  \"render.timeout_ms\": 123,\n  \"render.post_load_wait_ms\": 123,\n  \"render.ignore_https_errors\": true,\n  \"render.full_page\": true,\n  \"render.screenshot_format\": \"<string>\",\n  \"render.user_agent\": \"<string>\",\n  \"render.viewport\": {},\n  \"resources\": {},\n  \"resources.block\": [\n    {}\n  ],\n  \"actions\": [\n    {}\n  ],\n  \"actions[].type\": \"<string>\",\n  \"actions[].selector\": \"<string>\",\n  \"actions[].text\": \"<string>\",\n  \"actions[].css\": \"<string>\",\n  \"actions[].to\": \"<string>\",\n  \"actions[].wait_ms\": 123,\n  \"cookies\": [\n    {}\n  ],\n  \"capture_full_page\": true,\n  \"width\": 123,\n  \"height\": 123,\n  \"delay\": 123,\n  \"css_injection\": \"<string>\",\n  \"export_format\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "image_base64": "/9j/4AAQSkZJRg...",
  "content_type": "image/jpeg",
  "meta": {
    "elapsed_ms": 4521
  }
}

Validação

Consulta

Criação

Captura de ecrã síncrona

Primeiros passos

URL base

Exemplo de pedido

Opções de renderização

Campos de conveniência

Opções de recursos

Endpoint GET legacy

Parâmetros de pedido

Parâmetros de resposta

​Primeiros passos

​URL base

​Exemplo de pedido

​Opções de renderização

​Campos de conveniência

​Opções de recursos

​Endpoint GET legacy

​Parâmetros de pedido

​Parâmetros de resposta

Primeiros passos

URL base

Exemplo de pedido

Opções de renderização

Campos de conveniência

Opções de recursos

Endpoint GET legacy

Parâmetros de pedido

Parâmetros de resposta