SDK Java | Evocrawl

Instalação

O SDK Java oficial é mantido no monorepo do Evocrawl em apps/java-sdk. Para instalar o SDK Java do Evocrawl, adicione a dependência do Maven Central:

Gradle (Kotlin DSL)
Gradle (Groovy)
Maven

repositories {
    mavenCentral()
}

dependencies {
    implementation("com.evocrawl:evocrawl-java:1.1.1")
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.evocrawl:evocrawl-java:1.1.1'
}

<dependency>
    <groupId>com.evocrawl</groupId>
    <artifactId>evocrawl-java</artifactId>
    <version>1.1.1</version>
</dependency>

Requer Java 11 ou posterior.

Uso

Obtenha uma chave de API em evocrawl.dev
Defina a chave de API como uma variável de ambiente chamada EVOCRAWL_API_KEY ou passe-a com EvocrawlClient.builder().apiKey(...)

Aqui está um exemplo rápido usando a superfície atual da API do SDK:

import com.evocrawl.client.EvocrawlClient;
import com.evocrawl.models.CrawlJob;
import com.evocrawl.models.CrawlOptions;
import com.evocrawl.models.Document;
import com.evocrawl.models.ScrapeOptions;
import java.util.List;

public class Example {
    public static void main(String[] args) {
        EvocrawlClient client = EvocrawlClient.fromEnv();

        Document doc = client.scrape(
            "https://evocrawl.com",
            ScrapeOptions.builder()
                .formats(List.of((Object) "markdown"))
                .build()
        );

        CrawlJob crawl = client.crawl(
            "https://evocrawl.com",
            CrawlOptions.builder().limit(5).build()
        );

        System.out.println(doc.getMarkdown());
        System.out.println("Páginas rastreadas: " + (crawl.getData() != null ? crawl.getData().size() : 0));
    }
}

Fazendo scraping de uma URL

Para fazer scraping de uma única URL, use o método scrape.

import com.evocrawl.models.Document;
import com.evocrawl.models.ScrapeOptions;
import java.util.List;

Document doc = client.scrape(
    "https://evocrawl.com",
    ScrapeOptions.builder()
        .formats(List.of((Object) "markdown", "html"))
        .onlyMainContent(true)
        .waitFor(5000)
        .build()
);

System.out.println(doc.getMarkdown());
System.out.println(doc.getMetadata().get("title"));

Extração de JSON

Extraia JSON estruturado com JsonFormat por meio do endpoint scrape:

import com.evocrawl.models.Document;
import com.evocrawl.models.JsonFormat;
import com.evocrawl.models.ScrapeOptions;
import java.util.List;
import java.util.Map;

JsonFormat jsonFmt = JsonFormat.builder()
    .prompt("Extract the product name and price")
    .schema(Map.of(
        "type", "object",
        "properties", Map.of(
            "name", Map.of("type", "string"),
            "price", Map.of("type", "number")
        )
    ))
    .build();

Document doc = client.scrape(
    "https://example.com/product",
    ScrapeOptions.builder()
        .formats(List.of((Object) jsonFmt))
        .build()
);

System.out.println(doc.getJson());

Rastreamento de um site

Para rastrear um site e aguardar sua conclusão, use crawl.

import com.evocrawl.models.CrawlJob;
import com.evocrawl.models.CrawlOptions;
import com.evocrawl.models.Document;
import com.evocrawl.models.ScrapeOptions;
import java.util.List;

CrawlJob job = client.crawl(
    "https://evocrawl.com",
    CrawlOptions.builder()
        .limit(50)
        .maxDiscoveryDepth(3)
        .scrapeOptions(
            ScrapeOptions.builder()
                .formats(List.of((Object) "markdown"))
                .build()
        )
        .build()
);

System.out.println("Status: " + job.getStatus());
System.out.println("Progress: " + job.getCompleted() + "/" + job.getTotal());

if (job.getData() != null) {
    for (Document page : job.getData()) {
        System.out.println(page.getMetadata().get("sourceURL"));
    }
}

Iniciar um Rastreamento

Inicie uma tarefa sem esperar usando startCrawl.

import com.evocrawl.models.CrawlOptions;
import com.evocrawl.models.CrawlResponse;

CrawlResponse start = client.startCrawl(
    "https://evocrawl.com",
    CrawlOptions.builder().limit(100).build()
);

System.out.println("Job ID: " + start.getId());

Verificando o status do rastreamento

Verifique o progresso do rastreamento com getCrawlStatus.

import com.evocrawl.models.CrawlJob;

CrawlJob status = client.getCrawlStatus(start.getId());
System.out.println("Status: " + status.getStatus());
System.out.println("Progress: " + status.getCompleted() + "/" + status.getTotal());

Cancelando um Rastreamento

Cancele um rastreamento em execução com cancelCrawl.

import java.util.Map;

Map<String, Object> result = client.cancelCrawl(start.getId());
System.out.println(result);

Mapear um site

Descubra links em um site com map.

import com.evocrawl.models.MapData;
import com.evocrawl.models.MapOptions;
import java.util.Map;

MapData data = client.map(
    "https://evocrawl.com",
    MapOptions.builder()
        .limit(100)
        .search("blog")
        .build()
);

if (data.getLinks() != null) {
    for (Map<String, Object> link : data.getLinks()) {
        System.out.println(link.get("url") + " - " + link.get("title"));
    }
}

Buscando na Web

Faça uma busca com configurações de busca optional usando search.

import com.evocrawl.models.SearchData;
import com.evocrawl.models.SearchOptions;
import java.util.Map;

SearchData results = client.search(
    "evocrawl web scraping",
    SearchOptions.builder()
        .limit(10)
        .build()
);

if (results.getWeb() != null) {
    for (Map<String, Object> result : results.getWeb()) {
        System.out.println(result.get("title") + " - " + result.get("url"));
    }
}

Scraping em batch

Faça o scraping de várias URLs em paralelo com batchScrape.

import com.evocrawl.models.BatchScrapeJob;
import com.evocrawl.models.BatchScrapeOptions;
import com.evocrawl.models.Document;
import com.evocrawl.models.ScrapeOptions;
import java.util.List;

BatchScrapeJob job = client.batchScrape(
    List.of("https://evocrawl.com", "https://evocrawl.com/blog"),
    BatchScrapeOptions.builder()
        .options(
            ScrapeOptions.builder()
                .formats(List.of((Object) "markdown"))
                .build()
        )
        .build()
);

if (job.getData() != null) {
    for (Document doc : job.getData()) {
        System.out.println(doc.getMarkdown());
    }
}

Agente

Execute um agente com IA usando agent.

import com.evocrawl.models.AgentOptions;
import com.evocrawl.models.AgentStatusResponse;

AgentStatusResponse result = client.agent(
    AgentOptions.builder()
        .prompt("Find the pricing plans for Evocrawl and compare them")
        .build()
);

System.out.println(result.getData());

Com um esquema JSON para saída estruturada:

import com.evocrawl.models.AgentOptions;
import com.evocrawl.models.AgentStatusResponse;
import java.util.List;
import java.util.Map;

AgentStatusResponse result = client.agent(
    AgentOptions.builder()
        .prompt("Extract pricing plan details")
        .urls(List.of("https://evocrawl.com"))
        .schema(Map.of(
            "type", "object",
            "properties", Map.of(
                "plans", Map.of(
                    "type", "array",
                    "items", Map.of(
                        "type", "object",
                        "properties", Map.of(
                            "name", Map.of("type", "string"),
                            "price", Map.of("type", "string")
                        )
                    )
                )
            )
        ))
        .build()
);

System.out.println(result.getData());

Uso & métricas

Verifique a concorrência e os créditos restantes:

import com.evocrawl.models.ConcurrencyCheck;
import com.evocrawl.models.CreditUsage;

ConcurrencyCheck concurrency = client.getConcurrency();
System.out.println("Concurrency: " + concurrency.getConcurrency() + "/" + concurrency.getMaxConcurrency());

CreditUsage credits = client.getCreditUsage();
System.out.println("Remaining credits: " + credits.getRemainingCredits());

Suporte assíncrono

As variantes assíncronas já vêm integradas e retornam CompletableFuture.

import com.evocrawl.models.Document;
import com.evocrawl.models.ScrapeOptions;
import java.util.List;
import java.util.concurrent.CompletableFuture;

CompletableFuture<Document> future = client.scrapeAsync(
    "https://example.com",
    ScrapeOptions.builder()
        .formats(List.of((Object) "markdown"))
        .build()
);

future.thenAccept(doc -> System.out.println(doc.getMarkdown()));

Browser

O SDK Java inclui utilitários do Browser Sandbox.

Criar uma sessão

import com.evocrawl.models.BrowserCreateResponse;

BrowserCreateResponse session = client.browser(120, 60, true);
System.out.println(session.getId());
System.out.println(session.getCdpUrl());
System.out.println(session.getLiveViewUrl());

Executar código

import com.evocrawl.models.BrowserExecuteResponse;

BrowserExecuteResponse run = client.browserExecute(
    session.getId(),
    "await page.goto(\"https://example.com\"); console.log(await page.title());",
    "node",
    60
);

System.out.println(run.getStdout());
System.out.println(run.getExitCode());

Sessão Interativa Vinculada ao Scraping

Use o ID do job de scraping para executar código adicional no navegador no mesmo contexto reproduzido:

interact(...) executa código na sessão do navegador vinculada ao scraping (e a inicializa no primeiro uso).
stopInteraction(...) interrompe explicitamente a sessão interativa quando você terminar.

import com.evocrawl.models.BrowserDeleteResponse;
import com.evocrawl.models.BrowserExecuteResponse;

String scrapeJobId = "550e8400-e29b-41d4-a716-446655440000";

BrowserExecuteResponse scrapeRun = client.interact(
    scrapeJobId,
    "console.log(page.url());",
    "node",
    60
);

System.out.println(scrapeRun.getStdout());

BrowserDeleteResponse deleted = client.stopInteraction(scrapeJobId);
System.out.println("Deleted: " + deleted.isSuccess());

Listar & encerrar sessões

import com.evocrawl.models.BrowserDeleteResponse;
import com.evocrawl.models.BrowserListResponse;
import com.evocrawl.models.BrowserSession;

BrowserListResponse active = client.listBrowsers("active");
if (active.getSessions() != null) {
    for (BrowserSession s : active.getSessions()) {
        System.out.println(s.getId() + " - " + s.getStatus());
    }
}

BrowserDeleteResponse closed = client.deleteBrowser(session.getId());
System.out.println("Closed: " + closed.isSuccess());

Configuração

EvocrawlClient.builder() oferece suporte às seguintes opções:

Opção	Tipo	Padrão	Descrição
`apiKey`	`String`	variável de ambiente `EVOCRAWL_API_KEY` ou propriedade do sistema `evocrawl.apiKey`	Sua API key do Evocrawl
`apiUrl`	`String`	`https://api.evocrawl.com` (ou `EVOCRAWL_API_URL`)	URL base da API
`timeoutMs`	`long`	`300000`	Tempo limite da requisição HTTP em ms
`maxRetries`	`int`	`3`	Tentativas automáticas para falhas transitórias
`backoffFactor`	`double`	`0.5`	Fator de backoff exponencial em segundos
`asyncExecutor`	`Executor`	`ForkJoinPool.commonPool()`	Executor personalizado para métodos assíncronos
`httpClient`	`OkHttpClient`	Construído a partir de `timeoutMs`	Instância pré-configurada de `OkHttpClient`

import com.evocrawl.client.EvocrawlClient;

EvocrawlClient client = EvocrawlClient.builder()
    .apiKey("fc-your-api-key")
    .apiUrl("https://api.evocrawl.com")
    .timeoutMs(300_000)
    .maxRetries(3)
    .backoffFactor(0.5)
    .build();

Cliente HTTP personalizado

Você pode passar um OkHttpClient pré-configurado para controlar o pool de conexões, interceptadores, configuração de SSL, configurações de proxy e qualquer outro recurso do OkHttp. Quando fornecida, a configuração timeoutMs é ignorada e prevalece a configuração do próprio cliente.

import com.evocrawl.client.EvocrawlClient;
import okhttp3.OkHttpClient;

import java.net.InetSocketAddress;
import java.net.Proxy;
import java.util.concurrent.TimeUnit;

OkHttpClient custom = new OkHttpClient.Builder()
    .proxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy.example.com", 8080)))
    .addInterceptor(chain -> {
        System.out.println("Request: " + chain.request().url());
        return chain.proceed(chain.request());
    })
    .connectTimeout(10, TimeUnit.SECONDS)
    .readTimeout(60, TimeUnit.SECONDS)
    .build();

EvocrawlClient client = EvocrawlClient.builder()
    .apiKey("fc-your-api-key")
    .httpClient(custom)
    .build();

Tratamento de erros

O SDK lança exceções em tempo de execução em com.evocrawl.errors.

import com.evocrawl.errors.AuthenticationException;
import com.evocrawl.errors.EvocrawlException;
import com.evocrawl.errors.JobTimeoutException;
import com.evocrawl.errors.RateLimitException;
import com.evocrawl.models.Document;

try {
    Document doc = client.scrape("https://example.com");
} catch (AuthenticationException e) {
    System.err.println("Auth failed: " + e.getMessage());
} catch (RateLimitException e) {
    System.err.println("Rate limited: " + e.getMessage());
} catch (JobTimeoutException e) {
    System.err.println("Job " + e.getJobId() + " timed out after " + e.getTimeoutSeconds() + "s");
} catch (EvocrawlException e) {
    System.err.println("Error " + e.getStatusCode() + ": " + e.getMessage());
}

Você é um agente de IA que precisa de uma chave de API do Evocrawl? Consulte evocrawl.dev/agent-onboarding/SKILL.md para obter instruções automatizadas de onboarding.

Geral

Oficial

Java

Instalação

Uso

Fazendo scraping de uma URL

Extração de JSON

Rastreamento de um site

Iniciar um Rastreamento

Verificando o status do rastreamento

Cancelando um Rastreamento

Mapear um site

Buscando na Web

Scraping em batch

Agente

Uso & métricas

Suporte assíncrono

Browser

Criar uma sessão

Executar código

Sessão Interativa Vinculada ao Scraping

Listar & encerrar sessões

Configuração

Cliente HTTP personalizado

Tratamento de erros

​Instalação

​Uso

​Fazendo scraping de uma URL

​Extração de JSON

​Rastreamento de um site

​Iniciar um Rastreamento

​Verificando o status do rastreamento

​Cancelando um Rastreamento

​Mapear um site

​Buscando na Web

​Scraping em batch

​Agente

​Uso & métricas

​Suporte assíncrono

​Browser

​Criar uma sessão

​Executar código

​Sessão Interativa Vinculada ao Scraping

​Listar & encerrar sessões

​Configuração

​Cliente HTTP personalizado

​Tratamento de erros

Instalação

Uso

Fazendo scraping de uma URL

Extração de JSON

Rastreamento de um site

Iniciar um Rastreamento

Verificando o status do rastreamento

Cancelando um Rastreamento

Mapear um site

Buscando na Web

Scraping em batch

Agente

Uso & métricas

Suporte assíncrono

Browser

Criar uma sessão

Executar código

Sessão Interativa Vinculada ao Scraping

Listar & encerrar sessões

Configuração

Cliente HTTP personalizado

Tratamento de erros