ShortsMonkey DocumentaciónConsola APICrear clave

Inicio rápido

Cree una clave, verifique permisos, lea su primera clasificación y diagnostique errores de integración.

Antes de empezar#

Prepare una cuenta ShortsMonkey y una terminal del lado del servidor con acceso HTTPS. El ejemplo cURL necesita cURL; JavaScript necesita Node.js con recuperación; Python necesita solicitudes. Todas las claves que se muestran son marcadores de posición: use una clave de su propia cuenta.

1. Cree una clave y elija ámbitos.#

Inicie sesión, abra la consola API y copie la clave completa de la revelación única. Las solicitudes REST requieren api:read; Las herramientas MCP requieren mcp:leer. Seleccione ambos para ambas integraciones o solo el permiso que su integración necesita.

2. Establecer la variable de entorno#

export SHORTSMONKEY_API_KEY="sm_live_..."

3. Verificar gratis#

GET /v1/auth/verify, GET /v1/credits, GET /v1/credits/costs, las comprobaciones de estado y la gestión de claves no consumen las 10 llamadas diarias de datos. Se mantienen la autenticación y la comprobación de propiedad.

Ejecute curl -i https://api.shortsmonkey.com/v1/auth/verify -H "Authorization: Bearer $SHORTSMONKEY_API_KEY" en su terminal. Esta verificación REST también requiere api:read. Espere HTTP 200, luego confirme que data.authenticated sea verdadero y que data.scopes contenga api:read. La autenticación exitosa no garantiza una clasificación que no esté vacía.

4. Obtener la clasificación#

Ejecute uno de los ejemplos siguientes; no es necesario ejecutar los tres. La solicitud lee una instantánea de video largo chino estable almacenada y no activa una recuperación de YouTube en vivo. Primero verifique el estado de HTTP. Para una respuesta que no sea 200, lea error.code en lugar de tratar el error JSON como datos de clasificación.

5. Lea la respuesta y pagina#

data.all_data.items contiene la página actual antes de los filtros de solicitud; data.filter_data.items contiene la página actual después de los valores predeterminados y los filtros de solicitud. Cualquiera de las matrices puede estar vacía y sus recuentos pueden diferir; una matriz vacía no es un error de autenticación. Utilice meta.snapshot_at para evaluar la antigüedad de los datos y conserve meta.request_id para realizar diagnósticos.

Para otra página, pase all_data.next_cursor como all_cursor y filter_data.next_cursor como filter_cursor, manteniendo los filtros originales. null finaliza ese conjunto de resultados; no intercambie los cursor. Cada nueva solicitud de datos REST exitosa utiliza una llamada diaria. El hecho de que credits.unlimited sea verdadero no significa solicitudes de datos ilimitadas; consulte uso_diario.restante.

Solucionar problemas de la primera solicitud#

401 INVALID_API_KEY: verifique la clave sm_live_ completa, el espacio después del Portador, la variable de entorno y si la clave expiró, fue revocada o pasó su período de gracia de rotación. Para 403 INSUFICIENT_SCOPE, marque api:leer; para 403 ACCOUNT_DISABLED, verifique el estado de la cuenta y comuníquese con el soporte. Los reintentos repetidos no reparan la autenticación ni los permisos.

Distinguir 429 por código de error: API_DAILY_LIMIT_REACHED requiere esperar hasta las 00:00 Asia/Shanghai; RATE_LIMITED requiere reducir la frecuencia y las solicitudes simultáneas y respetar el reintento posterior cuando se proporciona. 503 DATA_STALE significa que la instantánea almacenada es demasiado antigua; SERVICE_UNAVAILABLE significa indisponibilidad temporal. Utilice reintentos limitados con retroceso y conserve el ID de la solicitud.

Registros clave de seguridad y verificación#

Mantenga la clave en una variable de entorno del lado del servidor o en un almacén secreto y envíela en el encabezado de Autorización. No lo incluya en el código del navegador, URL, Git, capturas de pantalla, registros o análisis. Comparta solo el ID de la solicitud, la operación, la hora, el estado y el código de error para el diagnóstico. Si está expuesta, gire o revoque la clave en la consola y actualice la configuración de su servidor.

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"