Documentazione API

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 è disponibile per qualsiasi account del Toolbox, senza che sia necessario comprare un pacchetto speciale o delle opzioni extra, mentre i dati dipendono dai moduli acquistati. Puoi addentrarti nei singoli metodi API tramite il menù di navigazione a destra. In questa pagina invece ti daremo una panoramica di tutte le informazioni generali sul nostro API.

I dati, le funzioni e i risultati ricavati via API non possono essere trasmessi a terzi senza un esplicito consenso scritto di SISTRIX.

Autenticazione

L’autenticazione ha luogo attraverso la trasmissione della tua API Key, che troverai all’interno del Toolbox. L’API Key deve essere inserita per tutte le richieste nel parametro “api_key”.

Nel Toolbox potrai inserire, rinominare e cancellare più API Keys. In questa pagina troverai un Logfile con le ultime richieste effettuate tramite le tue API Keys.

Sistema di crediti

Per l’uso dell’API verranno utilizzati i 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 settimanalmente, nella notte tra domenica a lunedì.

Tramite la richiesta seguente potrai venire a conoscenza della quantità di crediti rimasti per il tuo account del Toolbox:

https://api.sistrix.com/credits?api_key=[API_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. In alternativa, potrai ricevere i dati in formato JSON: in questo caso dovrai inserire il valore “json” al parametro “format” per ogni richiesta.

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“. È possibile richiedere i dati per tutti i Paesi disponibili nel Toolbox.

Valori possibili per il parametro del Paese (country): de, at, ch, it, es, fr, pl, nl, uk, us, se, br, tr, be, ie, pt, dk, no, fi, gr, hu, sk, cz, au, jp, ca

https://api.sistrix.com/...?country=[COUNTRY_CODE]

Database esteso

Le richieste API si basano di default sul database standard del Toolbox, cioè su due milioni di keyword per Paese (un milione per i dati desktop e un milione per i dati smartphone). In aggiunta, per alcune nazioni (Germania, Regno Unito e Spagna) 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“.

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

Rate Limit

L’API di ogni account del Toolbox è limitato a 300 accessi al minuto. Inoltre, devono trascorrere almeno 300 ms tra una richiesta e l’altra. Nel caso queste due limitazioni vengano superate, l’API risponderà con un codice di stato 429 (Too many requests), ma non scalerà i crediti per questa richiesta.