Documentación API

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 herramienta. Así, podrás integrarla fácilmente 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.

Autentificación de la API

La autenticación se realiza especificando la clave de la API. Esta clave de API se puede crear en la herramienta. La clave de la API debe transmitirse en el parámetro “api_key” para todas las consultas.

En la herramienta puedes crear varias claves de API, nombrarlas y borrarlas de nuevo. En esta página también encontrarás un archivo de registro con las últimas llamadas a la API con tus claves de API.

Sistema de créditos

Para utilizar la API, los créditos se deducen de la cuenta de créditos de tu cuenta. Los costes de los créditos se enumeran en la descripción de los métodos. El abono semanal en la cuenta de créditos se realiza durante la noche de domingo a lunes.

De la siguiente forma puedes determinar los créditos restantes de tu cuenta de la herramienta a través de la API.

https://api.sistrix.com/credits?api_key=[API_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, be, ie, pt, dk, no, fi, gr, hu, sk, cz, au, jp, ca

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

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 Smartphone

Además de los resultados de búsqueda en equipos de escritorio la Toolbox también devuelve resultados para búsquedas con smaartphone. 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 Smartphones, con lo cual, no se podrá utilizar en este caso el parámetro “extended”.

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

Límite de tarifa

La API está limitada a 300 visitas por minuto por cuenta de en la herramienta. Debe haber al menos 300 ms entre dos consultas. Si estos límites se exceden permanentemente, la API responde con el código de estado 429 (Too many requests), pero no calcula los créditos para esta consulta.