Documentazione API

de_DEes_ESfr_FRus
La documentazione API di SISTRIX permette ai server di accedere automaticamente alla maggior parte dei dati del Toolbox, in modo da poterli integrare facilmente in altri Tool o nel tuo lavoro quotidiano.

L’API è sempre disponibile all’interno del Toolbox, per cui non sarà necessario comprare un pacchetto speciale o di opzioni extra per usarlo, mentre i dati disponibili dipendono dai moduli acquistati. In questa pagina troverai tutte le informazioni generali sulla nostra API. È possibile accedere ai dati del Toolbox attraverso i metodi seguenti: dominio, keyword, link o Optimizer. Inoltre, esiste una pagina per i codici di ritorno dell’API e per i messaggi d’errore.

Connessione a Microsoft Excel, Fogli Google e Google Data Studio

Nonostante l’API SISTRIX sia stato originariamente sviluppato per l’uso di linguaggi di programmazione e di scripting, può anche essere utilizzato con Microsoft Excel, Fogli Google e Google Data Studio. Esploreremo questo tipo di collegamenti in articoli separati.

Autenticazione API

L’autenticazione ha luogo attraverso la trasmissione di una chiave API. Puoi ottenere la tua chiave API nella seguente pagina (la richiesta viene normalmente eseguita in breve tempo):

https://it.sistrix.com/account/api

La chiave API deve essere trasmessa attraverso il parametro “api_key” per ogni richiesta. Se questo non succede o se viene utilizzata una chiave API non valida, verrà riportato il messaggio d’errore “100”. Per poter ricevere una nuova chiave API, ti preghiamo di contattare il nostro supporto, che la cambierà il prima possibile.

Sistema di crediti

Per l’uso dell’API verranno utilizzati dei crediti del tuo account, che verranno addebitati a seconda dei dati richiesti. Il costo in crediti di ogni richiesta verrà indicato all’interno della descrizione del metodo. I crediti del tuo account si ricaricheranno nella notte tra domenica a lunedì di ogni settimana. Ciascun modulo del Toolbox mette a disposizione 10.000 crediti, non cumulabili da settimana in settimana. Nel caso siano stati acquistati tutti i moduli del Toolbox, ma si necessiti di ulteriori crediti per l’API, consigliamo di contattare il nostro supporto. Per sapere la quantità di crediti rimasti è possibile utilizzare l’API seguente:

https://api.sistrix.com/credits?api_key=$key

Formato di output

Tutti i valori delle richieste e delle risposte sono codificati in UTF-8. Normalmente, le risposte dell’interfaccia API hanno luogo in formato XML. Alternativamente, potrai ricevere i dati nel formato JSON e, in questo caso, il parametro “format” dovrà essere aggiunto a ogni URL con il valore “json”.

https://api.sistrix.com/...?format=json

Selezione del Paese

Nel caso non venga selezionato alcun Paese specifico, tutti i valori si riferiranno di default ai dati del Toolbox relativi alla Germania. Gli altri Paesi possono essere selezionati attraverso la trasmissione dei parametri “country”.

Valori possibili per il parametro del Paese (country): de, at, ch, it, es, fr, pl, nl, uk, us, se, br, tr

https://api.sistrix.com/...?country=$country

Base di dati estesa

Le richieste API si basano di default sul database standard del Toolbox, cioè su due milioni di keyword per nazione (un milione per i dati desktop e un milione per i dati smartphone). In aggiunta, per alcune nazioni offriamo un database esteso con ulteriori milioni di keyword: queste non vengono aggiornate settimanalmente, bensì mensilmente, ma sono molto più esaurienti. Per avere accesso al database esteso attraverso l’API, il parametro “extended” deve essere impostato sul valore “true”

https://api.sistrix.com/...?extended=true

Dati smartphone

In aggiunta ai risultati di ricerca desktop, il Toolbox calcola anche i risultati per ricerche effettuate da smartphone. Per recuperare questi risultati attraverso l’API, il parametro “mobile” deve essere impostato sul valore “true”. Il database esteso non è però disponibile per i dati smartphone, di conseguenza non è possibile una combinazione con “extended” .

https://api.sistrix.com/...?mobile=true