Pular para o conteúdo principal

Visão Geral da API Local

O TikMatrix fornece uma API RESTful local que permite gerenciar tarefas programaticamente. Isso é útil para integrar o TikMatrix com seus próprios sistemas de automação, construir fluxos de trabalho personalizados ou criar operações em lote.

Requisitos

Requisito de Licença

A API Local está disponível apenas para assinantes dos planos Pro, Team e Business. O plano Starter não tem acesso à API.

URL Base

A API é executada na sua máquina local em:

http://localhost:50809/api/v1/
observação

A porta 50809 é a porta padrão. Certifique-se de que o TikMatrix esteja em execução antes de fazer requisições à API.

Formato de Resposta

Todas as respostas da API seguem este formato:

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

Códigos de Resposta

CódigoDescrição
0Sucesso
40001Requisição Inválida - Parâmetros inválidos
40002Requisição Inválida - script_name ausente
40003Requisição Inválida - Script não suportado via API
40301Proibido - Acesso à API requer plano Pro+
40401Não Encontrado - Recurso não encontrado
50001Erro Interno do Servidor

Início Rápido

1. Verificar Acesso à API

Primeiro, verifique se sua licença suporta acesso à API:

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

Resposta:

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

2. Criar uma Tarefa

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": "Check out my new video! #viral"
},
"enable_multi_account": false,
"start_time": "14:30"
}'

3. Listar Tarefas

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

Scripts Disponíveis

O parâmetro script_name aceita os seguintes valores:

Nome do ScriptDescriçãoSuporte API
postPublicar conteúdo✅ Suportado
followSeguir usuários✅ Suportado
unfollowDeixar de seguir usuários✅ Suportado
account_warmupAquecer contas✅ Suportado
commentComentar em posts✅ Suportado
likeCurtir posts🔜 Em Breve
messageEnviar mensagens diretas🔜 Em Breve
super_marketingCampanha de super marketing🔜 Em Breve
profileAtualizar perfil🔜 Em Breve
scrape_userExtrair dados de usuário🔜 Em Breve

Status da Tarefa

Código de StatusTexto de StatusDescrição
0pendingTarefa aguardando execução
1runningTarefa em execução no momento
2completedTarefa concluída com sucesso
3failedTarefa falhou

Próximos Passos