Desarrolladores

Desarrolla con la API y los SDK

7:50 tutorial

La narración del video está en inglés.

La Toktik Developer API es una API REST medida por uso, además de SDK oficiales: @toktikhq/sdk-js para JavaScript/TypeScript y toktik para Python. Empieza con el inicio rápido, la autenticación y los créditos, y luego copia ejemplos listos de cURL, JavaScript y Python.

Lo que aprenderás

Crear una clave y hacer tu primera solicitud autenticada
Entender los scopes, los límites de frecuencia y el modelo de créditos
Usar los SDK de JavaScript y Python
Leer la documentación: inicio rápido, endpoints y scopes

Cómo funciona

Crea una clave en Settings
En la app abre Settings, luego Developer keys, y crea una clave solo con los scopes que necesites, como rank:read para rankings. El secreto empieza con ttk_live_ y se muestra una sola vez, así que guárdalo en una variable de entorno. Las claves solo pueden acceder a rutas de datos, y crear claves sigue siendo una acción que requiere sesión iniciada.
Haz tu primera solicitud
Envía la clave como Authorization: Bearer con tu secreto ttk_live_. El inicio rápido de la documentación llama al ranking oficial en api.toktikhq.com/v1/rankings/official con board=hourly y region=VN. Un 403 significa que la clave no tiene el scope de esa ruta.
Trabaja dentro de los límites y los créditos
Cada clave tiene un límite de solicitudes por segundo según el plan, de 1 en Free a 150 en Agency. Si lo superas recibes 429, así que espera el Retry-After y reintenta. Quedarte sin créditos devuelve 402, que reintentar no soluciona, y GET /v1/usage muestra tu consumo.
Añade un SDK oficial
Instala npm i @toktikhq/sdk-js para JavaScript y TypeScript, o pip install toktik para Python; ambos llaman a la misma API REST v1 con la misma clave y el mismo monedero de créditos. Las páginas de Docs, Quickstart y API Reference, listan cada endpoint, parámetro y scope.

Preguntas frecuentes

¿Cuánto cuesta la API de Toktik?

No hay una lista de precios de API aparte. La app web y la API gastan el mismo monedero de créditos del mismo plan. Una lectura servida desde el almacén de Toktik cuesta 1 crédito, una exportación cuesta 2,500 créditos y las llamadas de recopilación bajo demanda cuestan más.

¿Cuáles son los límites de frecuencia de la API de Toktik?

Por clave y por segundo: Free 1, Starter 5, Pro 20, Scale 60 y Agency 150. También se aplican cuotas diarias, desde 5,000 solicitudes en Free hasta 1,200,000 en Agency. Superar el límite devuelve 429 con encabezados que muestran el estado de la ventana.

¿Toktik tiene SDK oficiales?

Sí. @toktikhq/sdk-js cubre JavaScript y TypeScript, y el paquete toktik cubre Python. Ambos llaman a la misma API REST v1 con la misma clave.

¿Cuál es la diferencia entre un 402 y un 403 de la API de Toktik?

Un 402 significa que el espacio de trabajo se quedó sin créditos, así que recarga en lugar de reintentar. Un 403 significa que la clave es válida pero no tiene el scope requerido, así que concédelo o usa una sesión iniciada. Un 429 es un límite de frecuencia y es seguro reintentar tras esperar.

Leer la documentación de la API Todas las guías