TAPSAVE OPEN API

Medienanalyse über einen Endpoint integrieren

Analysiere öffentliche Medien über einen stabilen REST-Endpoint. Ein Guthaben wird nur bei nutzbaren Ergebnissen berechnet.

REST / JSONEin Analyse-EndpointKeine Kosten bei Fehlern
POST /openapi/parse
curl -X POST https://api.videotool.cc/openapi/parse \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://..."}'
200 OK1 Guthaben

01 · Schnellstart

Analyseanfrage senden

Füge den API-Schlüssel zum Header hinzu und sende eine öffentliche URL im JSON-Inhalt.

curl -X POST https://api.videotool.cc/openapi/parse \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://..."}'

02 · Authentifizierung

Mit API-Schlüssel authentifizieren

Sende X-API-Key bei jeder Anfrage. Der Schlüssel kann in der Konsole verwaltet werden.

X-API-KeyYOUR_API_KEY

Bewahre API-Schlüssel auf dem Server auf und veröffentliche sie nicht in Apps oder Repositories.

03 · Endpoint

Verfügbarer Endpoint

POST/openapi/parseEinzelne URL

Eine öffentliche Medien-URL analysieren

Sende eine öffentliche Beitrags- oder Video-URL. Nach nutzbaren Ergebnissen wird ein Guthaben berechnet.

urlstring · requiredÖffentliche Beitrags- oder Video-URL

04 · Antwort

Erfolgreiche Antwort

Ein erfolgreicher Aufruf liefert ParseResult in AjaxResult mit Video-, Bild-, Audio- und Textressourcen.

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "resultCode": 0,
    "hasResource": true,
    "resourceType": 200,
    "descList": ["..."],
    "imgList": [],
    "videoList": [],
    "audioList": []
  }
}

Response fields

Fields can be empty depending on the source platform and resource type. Check code, data.resultCode, and data.hasResource before reading a resource list.

codenumberBusiness status code; 200 means the request succeeded.
msgstringProcessing message; failures include a displayable reason.
data.resultCodenumberParse result code; 0 means parsing succeeded.
data.resultMsgstring | nullParse result message; normally null on success.
data.hasResourcebooleanWhether usable media was returned; one credit is charged only when true.
data.resourceTypenumberResource type returned by the parser; use the resource lists to identify actual content.
data.parseBynumber | nullParser source or strategy identifier for display and diagnostics only.
data.ffmpegCmdstring | nullFFmpeg command template for source-required transcoding; normal browser playback does not run it.
data.headersobjectHeaders that can be required for direct raw-media requests; normally unnecessary with webProxyUrl.
data.canWatchAdbooleanWhether ad-based parse entitlement is supported; Open API clients normally do not use it.
data.showProxy / data.proxyBaseUrlboolean / string | nullOrdinary download-proxy settings, separate from the Web display proxy.
data.timestampnumberMillisecond timestamp for this response; required in a web proxy URL.
data.webProxyUrlstring | nullWeb display proxy base URL; append /res/dl when present, otherwise use the resource URL.
data.packageDownloadUrlstring | nullPackage-download base URL, used only for /res/zip and generated /static paths.
data.vipProxyBaseUrl / data.vipDownloadStatusstring | nullVIP fast-download fields; standard Open API integrations should not depend on them.
data.vipPackageDownloadUrl / data.vipPackageDownloadStatusstring | nullVIP package-download fields; standard Open API integrations should not depend on them.
data.descList[]string[] | nullOriginal caption, title, or supplemental descriptions.
data.authorstring | nullXiaohongshu author nickname when available.
data.publishTimestring | nullXiaohongshu publish time in yyyy-MM-dd HH:mm:ss format.
data.publishTimestampnumber | nullXiaohongshu publish timestamp in seconds.
data.imgList[].url / origUrlstringImage resource URL and optional original source URL.
data.imgList[].webImgHashstring | nullWeb image proxy signature; fall back to imgHash only when it is absent.
data.imgList[].videoUrlstring | nullVideo linked to an image item when available.
data.imgList[].webVideoHashstring | nullWeb proxy signature for an image item linked video.
data.videoList[].idstring | nullVideo resource identifier for rendering or deduplication.
data.videoList[].url / origUrlstringVideo resource URL and optional original source URL.
data.videoList[].width / heightstring | nullVideo dimensions in px when supplied by the source.
data.videoList[].webVideoHashstring | nullWeb video proxy signature; fall back to videoHash only when absent.
data.videoList[].audioUrlstring | nullSeparate audio resource URL when available.
data.videoList[].webAudioHashstring | nullWeb audio proxy signature; fall back to audioHash only when absent.
data.videoList[].descstring | nullSupplemental description for the video resource.
data.audioList[].url / origUrlstringStandalone audio URL and optional original source URL.

05 · Proxy URLs

Use the web display proxy URL

When webProxyUrl is present, browsers can use a proxied resource URL to handle CORS or origin hotlink restrictions. Use the raw resource URL when it is empty.

const data = result.data;
const video = data.videoList[0];
const rawUrl = video.url;

const displayUrl = data.webProxyUrl
  ? data.webProxyUrl.replace(/\/+$/, '')
    + '/res/dl?url=' + encodeURIComponent(rawUrl)
    + '&hash=' + (video.webVideoHash || video.videoHash)
    + '&timestamp=' + data.timestamp
  : rawUrl;

// <video src={displayUrl} controls />
Signature and resource rules

Use webImgHash (falling back to imgHash) for images, webVideoHash (falling back to videoHash) for videos, and webAudioHash (falling back to audioHash) for video audio. Use only the hash and timestamp returned by the same parse response. Do not use webProxyUrl for /res/zip package downloads.

06 · Fehler

Geschäftsfehlercodes

codeBedeutungKosten
400URL fehlt oder ist ungültigKostenfrei
401API-Schlüssel fehlt, ist ungültig oder deaktiviertKostenfrei
403Nicht genügend GuthabenKostenfrei
422Keine nutzbare Ressource zurückgegebenKostenfrei
500Fehler des AnalysedienstesKostenfrei

07 · Abrechnung

Nur erfolgreiche Ergebnisse werden berechnet

1Guthaben bei nutzbaren Ergebnissen berechnet
0Guthaben bei Fehlern oder leeren Ergebnissen berechnet
Aktueller Umfang

Open API bietet nur POST /openapi/parse für eine URL. Keine Batch-, Capabilities-, Idempotenz-Cache- oder Rate-Limit-Endpoints.