> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI di Octoparse

> Riferimento OpenAPI di Octoparse per autenticazione, gestione delle attività, estrazione cloud ed esportazione dei dati.

Usa l'OpenAPI di Octoparse per gestire le attività, eseguire estrazioni cloud e recuperare programmaticamente i dati raccolti.

## Autenticazione

Per gli endpoint protetti, il metodo di autenticazione più semplice è una chiave API Octoparse. Crea una chiave nel centro account Octoparse, quindi includila nell'header della richiesta `x-api-key`. La stessa chiave API può essere usata con l'OpenAPI di Octoparse, il server MCP e la CLI.

> [card] [Crea o gestisci le chiavi API](https://www.octoparse.it/console/open-platform/api-keys)
>
> Apri la pagina delle chiavi API nel centro account Octoparse.

Le chiavi API in genere iniziano con `op_sk_`:

```bash theme={null}
curl "https://openapi.octoparse.com/taskGroup" \
  --header "x-api-key: op_sk_xxxxx"
```

> [!WARNING]
>
> Mantieni segreta la chiave API. Non esporla in codice eseguito nel browser, repository pubblici, screenshot o log.

È supportata anche l'autenticazione tramite token di accesso. Ottieni un token di accesso da `POST /token`, quindi invialo come `Authorization: Bearer <access_token>`.

## API AgentTools

L'API AgentTools è un livello di flusso di lavoro basato su modelli e destinato agli agenti AI, costruito sulle API legacy di basso livello per attività, estrazione cloud e dati. Usalo quando un agente o un'automazione deve individuare un modello di scraping adatto, avviare un'esecuzione, seguire le indicazioni del server sui passaggi successivi e recuperare i metadati di esportazione senza collegare direttamente ogni endpoint di basso livello.

Flusso per un nuovo scraping:

```text theme={null}
searchTemplates -> executeTask -> exportData
```

Flusso per un'attività esistente:

```text theme={null}
searchTasks -> startOrStopTask -> exportData
```

Non conosci ancora AgentTools? Leggi il [tutorial completo sul flusso di lavoro](https://helpcenter.octoparse.com/it/articles/15855832-run-a-scraping-workflow-with-the-octoparse-agenttools-api) per imparare a cercare modelli, avviare un'attività ed esportare i risultati.

Le risposte AgentTools mantengono i campi operativi all'interno di `data`. Usa `requestId` solo per la risoluzione dei problemi e segui `retryGuidance`, `suggestedNextCall`, `workflow` e `toolHint` invece di impostare intervalli di polling fissi nel codice.

> [!NOTE]
>
> L'API AgentTools richiede l'autenticazione `x-api-key`. Alcuni endpoint richiedono anche `x-external-user-id`; consulta il riferimento di ciascun endpoint per gli header esatti.

## Prima di iniziare

Per usare l'OpenAPI di Octoparse, è necessario un account **Standard, Professionale o Enterprise** con almeno un'attività funzionante. [Registrati qui](https://www.octoparse.it/signup) se non ne hai ancora uno.

Versione API corrente: **v1.0**

## URL di base

Tutte le richieste devono essere codificate come URL rispetto all'URL di base:

```text theme={null}
https://openapi.octoparse.com
```

I segnaposto sono mostrati come `{xxxx}` e devono essere sostituiti con valori reali. Ad esempio, l'URL della richiesta per *Cerca attività* è:

```text theme={null}
GET https://openapi.octoparse.com/task/search?taskGroupId={taskGroupId}
```

Se l'ID del gruppo di attività è `abc`, l'URL diventa `https://openapi.octoparse.com/task/search?taskGroupId=abc`.

## Limiti di frequenza

Octoparse limita l'uso delle API a **20 richieste al secondo**. Se ricevi un codice di stato `429`, riduci la frequenza delle richieste.

Una risposta riuscita restituisce HTTP `200`. Per gli altri codici di stato, consulta la sezione [Riferimenti](#) di ciascun endpoint.

## Autorizzazioni

Assicurati che il tuo account disponga dell'autorizzazione necessaria per usare ciascun servizio. In caso contrario, effettua l'upgrade dell'account.

| Servizio | API | Piano richiesto |
| - | - | - |
| Token di accesso | Ottieni un nuovo token | Tutti gli utenti |
| Token di accesso | Aggiorna token | Tutti gli utenti |
| Gruppo di attività | Ottieni informazioni sul gruppo di attività | Standard, Professionale, Enterprise |
| Attività | Cerca attività | Standard, Professionale, Enterprise |
| Attività | Duplica attività | Standard, Professionale, Enterprise |
| Attività | Sposta attività | Standard, Professionale, Enterprise |
| Attività | Ottieni parametri azione | Professionale, Enterprise |
| Attività | Aggiorna parametri attività | Professionale, Enterprise |
| Attività | Aggiorna parametri azione | Professionale, Enterprise |
| Attività | Aggiorna elenco degli elementi in loop | Professionale, Enterprise |
| Attività | Aggiorna URL attività | Professionale, Enterprise |
| Estrazione cloud | Avvia attività | Professionale, Enterprise |
| Estrazione cloud | Interrompi attività | Professionale, Enterprise |
| Estrazione cloud | Ottieni stato attività | Professionale, Enterprise |
| Estrazione cloud | Ottieni stato attività V2 | Professionale, Enterprise |
| Estrazione cloud | Ottieni stato sottoattività | Professionale, Enterprise |
| Estrazione cloud | Avvia sottoattività | Professionale, Enterprise |
| Estrazione cloud | Interrompi sottoattività | Professionale, Enterprise |
| Dati | Ottieni dati non esportati | Standard, Professionale, Enterprise |
| Dati | Contrassegna dati come esportati | Standard, Professionale, Enterprise |
| Dati | Ottieni dati per offset | Standard, Professionale, Enterprise |
| Dati | Ottieni dati da un batch specifico per offset | Standard, Professionale, Enterprise |
| Dati | Rimuovi dati | Standard, Professionale, Enterprise |

## Risoluzione dei problemi

Ogni risposta include un `requestId`. Se una richiesta non riesce, condividi il `requestId` con il [team di assistenza Octoparse](mailto:support@octoparse.com) per facilitare la diagnosi del problema.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.