Documentación API

La interfaz de la API de la SISTRIX Toolbox permite el acceso automático de la máquina apropiada a una gran parte de los datos de la Toolbox. Así, podrás integrarla con facilidad en tus propios procesos y herramientas.

La API de la Toolbox está incluida en todas las cuentas Toolbox. Para usarla no hace falta ningún paquete ni opción especial. Los datos disponibles corresponden a los módulos Toolbox adquiridos. En esta página se proporciona información general de la API. La petición de datos de la Toolbox se realiza mediante los siguientes métodos: Domain-, Keyword-, Link- y Optimizer-. Estos métodos vienen descritos detalladamente por separado. También existe una página de códigos de retorno de la API y de mensajes de error.

Conexión con tablas de Microsoft Excel y Google

Aunque la API de SISTRIX está diseñada originalmente para usarla con secuencias de comandos y lenguaje de programación, también puede usarse con tablas de Microsoft Excel y Google. Las particularidades y características de esta posibilidad se explican en dos artículos sobre este tema.

Autenticación en la API

La autenticación se realiza mediante una clave API (API-Key). Esta clave puede solicitarse en la siguiente página y, por lo general, no tarda mucho en generarse.

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

La clave API debe introducirse en todas las solicitudes en el parámetro “api-key”. Si no se hace así o se introduce una clave no válida, la API devolverá el código de error “100”. Para obtener una nueva API-Key, contacta con nuestro servicio de asistencia. Te la cambiaremos de una forma rápida y sencilla.

Sistema de créditos

Para usar la API tienes que solicitar que te descuenten créditos de la cuenta de crédito de tu cuenta. En la descripción de los métodos se especifican los créditos que necesitas en cada caso. La cuenta de crédito se rellena la noche del domingo al lunes. Los abonados Pro del módulo Toolbox recibirán 10.000 créditos en su cuenta de crédito. Los créditos no utilizados en la semana anterior no son acumulables. Si ya tienes los 5 módulos Toolbox y necesitas más créditos API, se puede llegar a un acuerdo individual. Para ello, deberás contactar con el servicio de asistencia de Toolbox. Los créditos restantes también se pueden solicitar en la API:

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

Formato de salida

Todas las solicitudes y valores de retorno están codificados en UTF-8. Por defecto, el retorno de la interfaz de la API se realiza en formato XML. Opcionalmente se puede cambiar al formato JSON. Para ello, habría que poner en el parámetro “format” el valor “json” en cada URL.

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

Selección de país

Si no se especifica un país, todos los valores de retorno de los datos de la Toolbox se referirán a Alemania. Se pueden seleccionar otros países utilizando el parámetro “country”.

Valores posibles del parámetro Country-: de, at, ch, it, es, fr, pl, nl, uk, us, se, br, tr

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

Base de datos ampliada

Las entradas API se realizan por defecto en la base de datos estándar de la Toolbox. Esto supone dos millones de palabras clave por país: un millón para resultados de equipos de escritorio y un millón para datos de teléfonos inteligentes, respectivamente. En algunos países ofrecemos una base de datos ampliada, con millones de palabras clave. Estas, debido a su amplitud, obviamente se actualizan mensualmente y no semanalmente. Para acceder a la API de base de datos avanzada hay que poner el valor “true” en el parámetro “extended”.

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

Datos de teléfonos inteligentes

Además de los resultados de búsqueda en equipos de escritorio la Toolbox también devuelve resultados para búsquedas con teléfonos inteligentes. Para consultar esos resultados en la API hay que introducir el valor “true” en el parámetro “mobile”. La base de datos ampliada no está disponible para datos de teléfonos inteligentes, con lo cual, no se podrá utilizar en este caso el parámetro “extended”.

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