본문으로 건너뛰기

로컬 API 개요

TikMatrix는 프로그래밍 방식으로 작업을 관리할 수 있는 로컬 RESTful API를 제공합니다. 이는 TikMatrix를 자체 자동화 시스템과 통합하거나, 사용자 정의 워크플로우를 구축하거나, 일괄 작업을 생성하는 데 유용합니다.

요구 사항​

라이선스 요구 사항

로컬 API는 Pro, Team, Business 플랜 구독자만 사용할 수 있습니다. Starter 플랜은 API에 액세스할 수 없습니다.

기본 URL​

API는 로컬 머신에서 실행됩니다:

http://localhost:50809/api/v1/
노트

포트 50809는 기본 포트입니다. API 요청을 하기 전에 TikMatrix가 실행 중인지 확인하세요.

응답 형식​

모든 API 응답은 다음 형식을 따릅니다:

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

응답 코드​

코드설명
0성공
40001잘못된 요청 - 유효하지 않은 매개변수
40002잘못된 요청 - script_name 누락
40003잘못된 요청 - 지원되지 않는 스크립트 또는 잘못된 작업 상태
40004잘못된 요청 - 실행 중인 작업만 중지할 수 있습니다
40005잘못된 요청 - task_ids는 비워둘 수 없습니다
40301금지 - API 액세스에는 Pro+ 플랜 필요
40401찾을 수 없음 - 리소스를 찾을 수 없음
50001내부 서버 오류

빠른 시작​

1. API 액세스 확인​

먼저 라이선스가 API 액세스를 지원하는지 확인합니다:

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

응답:

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

2. 작업 생성​

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": "새 동영상을 확인하세요! #바이럴"
    },
    "enable_multi_account": false,
    "start_time": "14:30"
  }'

3. 작업 목록 조회​

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

사용 가능한 스크립트​

script_name 매개변수에서 허용하는 값:

스크립트 이름설명API 지원
post콘텐츠 게시✅ 지원됨
follow사용자 팔로우✅ 지원됨
unfollow사용자 언팔로우✅ 지원됨
account_warmup계정 워밍업✅ 지원됨
comment게시물에 새 댓글✅ 지원됨
boost_comment기존 댓글 좋아요/답글✅ 지원됨
login계정 로그인✅ 지원됨
profile프로필 업데이트✅ 지원됨
match_account기기의 계정 매칭✅ 지원됨
like게시물 좋아요✅ 지원됨
view게시물을 일정 시간 동안 시청✅ 지원됨
favorite게시물을 즐겨찾기에 저장✅ 지원됨
repostTikTok 동영상 리포스트✅ 지원됨
message다이렉트 메시지✅ 지원됨
follow_suggested추천 계정 팔로우✅ 지원됨
super_marketing슈퍼 마케팅 캠페인✅ 지원됨 †
scrape_user사용자 데이터 스크래핑🔜 출시 예정
† 슈퍼 마케팅은 전용 엔드포인트 사용

슈퍼 마케팅 캠페인은 POST /api/v1/task를 통해 생성하지 않습니다. 재사용 가능한 타겟 데이터셋을 기반으로 실행되며 전용 엔드포인트가 있습니다 — 슈퍼 마케팅 스크립트 구성을 참고하세요.

작업 상태​

상태 코드상태 텍스트설명
0pending작업 실행 대기 중
1running작업 실행 중
2completed작업 성공적으로 완료
3failed작업 실패

다음 단계​