Saltar al contenido principal

Visión General de la API Local

TikMatrix proporciona una API RESTful local que te permite gestionar tareas de forma programática. Esto es útil para integrar TikMatrix en tus propios sistemas de automatización, construir flujos de trabajo personalizados o crear operaciones por lotes.

Requisitos

Requisito de Licencia

La API local está disponible solo para usuarios de los planes Pro, Team y Business. El plan Starter no proporciona acceso a la API.

URL Base

La API se ejecuta localmente en:

http://localhost:50809/api/v1/
nota

El puerto 50809 es el puerto predeterminado. Asegúrate de que TikMatrix esté en ejecución antes de realizar solicitudes.

Formato de Respuesta

Todas las respuestas de la API siguen este formato:

{
"code": 0,
"message": "success",
"data": { ... }
}

Códigos de Respuesta

CodeDescripción
0Éxito
40001Error de parámetro - Parámetros de solicitud inválidos
40002Error de parámetro - Falta script_name
40003Error de parámetro - Script no soportado o estado de tarea inválido
40004Error de parámetro - Solo se pueden detener tareas en ejecución
40005Error de parámetro - task_ids no puede estar vacío
40301Prohibido - El acceso a la API requiere plan Pro+
40401No encontrado - El recurso no existe
50001Error interno del servidor

Inicio Rápido

1. Verificar Acceso a la API

Primero, confirma si tu licencia soporta API:

curl http://localhost:50809/api/v1/license/check

Respuesta de ejemplo:

{
"code": 0,
"message": "success",
"data": {
"plan_name": "Pro",
"api_enabled": true,
"device_limit": 20,
"message": "API access enabled"
}
}

2. Crear una Tarea

curl -X POST http://localhost:50809/api/v1/task \
-H "Content-Type: application/json" \
-d '{
"serials": ["device_serial_1", "device_serial_2"],
"script_name": "post",
"script_config": {
"content_type": 1,
"captions": "¡Mira mi nuevo video! #viral"
},
"enable_multi_account": false
}'

3. Listar Tareas

curl http://localhost:50809/api/v1/task?status=0&page=1&page_size=20

Scripts Disponibles

El parámetro script_name acepta los siguientes valores:

Nombre del ScriptDescripciónSoporte API
postPublicar contenido✅ Compatible
followSeguir usuarios✅ Compatible
unfollowDejar de seguir✅ Compatible
account_warmupCalentamiento de cuenta✅ Compatible
commentPublicar un comentario en posts✅ Compatible
boost_commentDar me gusta/responder comentarios existentes✅ Compatible
loginIniciar sesión en cuenta✅ Compatible
profileActualizar perfil✅ Compatible
match_accountVincular cuentas en dispositivo✅ Compatible
likeMe gusta a posts✅ Compatible
viewVer una publicación durante un tiempo✅ Compatible
favoriteGuardar una publicación en Favoritos✅ Compatible
repostRepostear vídeos de TikTok✅ Compatible
messageMensaje directo✅ Compatible
follow_suggestedSeguir cuentas sugeridas✅ Compatible
super_marketingCampaña de supermarketing✅ Compatible †
scrape_userExtraer datos de usuario🔜 Próximamente
† El supermarketing usa endpoints dedicados

La campaña de supermarketing no se crea a través de POST /api/v1/task. Funciona con un dataset reutilizable de objetivos y tiene sus propios endpoints — consulta la Configuración del Script Super Marketing.

Estados de Tarea

Código de EstadoTexto de EstadoDescripción
0pendingTarea esperando ejecución
1runningTarea en ejecución
2completedTarea completada exitosamente
3failedTarea fallida

Siguiente Paso