Riferimento API

La documentazione API SISTRIX per il Toolbox permette l’accesso automatico ai server per la maggior parte dei dati del Toolbox. In questo modo potrai integrare facilmente quest’ultimo nei tuoi processi e strumenti interni.

L’API è parte del tuo account Toolbox, per cui non avrai bisogno di un pacchetto speciale o di opzioni extra, mentre i dati disponibili dipendono dai moduli prenotati. Su questa pagina, troverai informazioni generali sulla nostra API. È possibile accedere ai dati del Toolbox attraverso un dominio, una parola chiave, un collegamento o dei metodi d’ottimizzazione, che sono però documentati su pagine separate. Similmente, esiste una pagina per i codici di ritorno dell’API e per i messaggi d’errore.

Connessione a Microsoft Excel e a Google Tables

Nonostante l’API SISTRIX sia stata originariamente sviluppata per l’uso di linguaggi di programmazione e di scripting, essa può anche essere utilizzata in connessione a Microsoft Excel e a Google Tables. Esploreremo come connettere queste due soluzioni in articoli separati.

Autenticazione API

L’autenticazione ha luogo attraverso la trasmissione di una chiave API. Puoi richiedere la tua chiave API nella seguente pagina e sarà solitamente disponibile entro breve:

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

La chiave API deve essere trasmessa attraverso il parametro “api_key” con ogni richiesta. Se questo non succede o se viene utilizzata una chiave API non valida, l’API riporterà il messaggio d’errore “100”. Per poter ricevere la nuova chiave API, ti preghiamo di contattare il nostro supporto: la cambieremo immediatamente.

Sistema di crediti

I crediti sono addebitati al tuo account a seconda dei dati richiesti. I rispettivi costi dei crediti sono elencati di fianco alle descrizioni. I crediti del tuo account si ricaricano nella notte tra domenica a lunedì. Per ogni iscrizione a un modulo del Toolbox, l’account avrà a disposizione 10.000 crediti. I crediti non si accumulano dalla settimana precedente. In caso tu sia iscritto già a tutti i 5 moduli del Toolbox, ma abbia bisogno di ulteriori crediti per l’API, contatta il nostro supporto, e valuteremo a seconda delle tue necessità. La quantità di crediti rimanenti può essere ottenuta attraverso l’API:

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

Se nessun Paese verrà selezionato esplicitamente, tutti i valori restituiti si riferiranno 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 hanno luogo, in automatico, sul database standard del Toolbox, cioè su due milioni di keyword per nazione – rispettivamente, un milione per i risultati desktop e un milione per i dati smartphone. In aggiunta, per alcune nazioni offriamo un database esteso con milioni di altre parole-chiave: queste non vengono aggiornate settimanalmente, bensì mensilmente, ma sono molto più esaurienti. Per raggiungere il 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