ShortsMonkey DocumentazioneConsole APICrea chiave

Avvio rapido

Crea una chiave, verifica le autorizzazioni, leggi la tua prima classifica e diagnostica gli errori di integrazione.

Prima di iniziare#

Preparare un account ShortsMonkey e un terminale lato server con accesso HTTPS. L'esempio cURL necessita di cURL; JavaScript necessita di Node.js con fetch; Python ha bisogno di richieste. Tutte le chiavi mostrate sono segnaposto: usa una chiave dal tuo account.

1. Crea una chiave e scegli gli ambiti#

Accedi, apri la console API e copia la chiave completa dalla rivelazione unica. Le richieste REST richiedono api:read; Gli strumenti MCP richiedono mcp:read. Seleziona entrambi per entrambe le integrazioni oppure solo l'autorizzazione necessaria per la tua integrazione.

2. Impostare la variabile di ambiente#

export SHORTSMONKEY_API_KEY="sm_live_..."

3. Verifica gratuitamente#

GET /v1/auth/verify, GET /v1/credits, GET /v1/credits/costs, i controlli di stato e la gestione delle chiavi non consumano le 10 chiamate dati giornaliere. Autenticazione e verifica della proprietà restano obbligatorie.

Esegui curl -i https://api.shortsmonkey.com/v1/auth/verify -H "Authorization: Bearer $SHORTSMONKEY_API_KEY" nel tuo terminale. Questo controllo REST richiede anche api:read. Aspettarsi HTTP 200, quindi verificare che data.authenticated sia vero e che data.scopes contenga api:read. L'autenticazione riuscita non garantisce una classifica non vuota.

4. Recupera la classifica#

Esegui uno degli esempi seguenti; non è necessario eseguirli tutti e tre. La richiesta legge un'istantanea video cinese stabile memorizzata e non attiva un recupero YouTube in tempo reale. Controllare prima lo stato HTTP. Per una risposta diversa da 200, leggi error.code invece di considerare l'errore JSON come dati di classificazione.

5. Leggi la risposta e impaginala#

data.all_data.items contiene la pagina corrente prima dei filtri di richiesta; data.filter_data.items contiene la pagina corrente dopo i valori predefiniti e i filtri di richiesta. Entrambi gli array potrebbero essere vuoti e i relativi conteggi potrebbero differire; un array vuoto non rappresenta un errore di autenticazione. Utilizza meta.snapshot_at per valutare l'età dei dati e conservare meta.request_id per la diagnostica.

Per un'altra pagina, passa all_data.next_cursor come all_cursor e filter_data.next_cursor come filter_cursor, mantenendo i filtri originali. null termina il set di risultati; non scambiare gli cursor. Ogni nuova richiesta di dati REST riuscita utilizza una chiamata giornaliera. Il fatto che credits.unlimited sia vero non significa richieste di dati illimitate; controlla daily_usage.remaining.

Risolvi i problemi della prima richiesta#

401 INVALID_API_KEY: controlla la chiave sm_live_ completa, lo spazio dopo Bearer, la variabile di ambiente e se la chiave è scaduta, è stata revocata o ha superato il periodo di tolleranza della rotazione. Per 403 INSUFFICIENT_SCOPE, controlla api:read; per 403 ACCOUNT_DISABLED, controlla lo stato dell'account e contatta l'assistenza. I tentativi ripetuti non ripristinano l'autenticazione o le autorizzazioni.

Distinguere 429 in base al codice errore: API_DAILY_LIMIT_REACHED richiede l'attesa fino alle 00:00 Asia/Shanghai; RATE_LIMITED richiede la riduzione della frequenza e delle richieste simultanee e il rispetto del Retry-After quando fornito. 503 DATA_STALE significa che lo snapshot archiviato è troppo vecchio; SERVICE_UNAVAILABLE indica indisponibilità temporanea. Utilizza tentativi limitati con backoff e conserva l'ID richiesta.

Documenti chiave di sicurezza e verifica#

Conserva la chiave in una variabile di ambiente lato server o in un archivio segreto e inviala nell'intestazione Autorizzazione. Non inserirlo nel codice del browser, URLs, Git, screenshot, log o analisi. Condividi solo l'ID della richiesta, l'operazione, l'ora, lo stato e il codice di errore per la diagnostica. Se esposto, ruota o revoca la chiave nella console e aggiorna la configurazione del server.

curl -X GET "https://api.shortsmonkey.com/v1/rankings/chinese-low-subscriber-long-videos?period=today&quality=strict&limit=20" \
  -H "Authorization: Bearer $SHORTSMONKEY_API_KEY"