StarDots.io Logo

StarDots

Inicio de la documentación

API Abierta

Este capítulo introducirá cómo integrar APIs abiertas. Los siguientes conocimientos son para desarrolladores y asumimos que tienes una cierta base en programación.

¿Eres un agente de IA? Consulta la documentación en Markdown
En esta página

Autenticación

StarDots realiza la autenticación leyendo el campo de los encabezados en la solicitud HTTP iniciada por el cliente y verificando los campos relevantes. Por lo tanto, todas las solicitudes de API abierta deben incluir esta información de autenticación, y debes tener en cuenta que estos campos son sensibles a mayúsculas y minúsculas, y todos los campos deben estar en minúsculas.

  • x-stardots-timestamp
    Descripción
    Sello de tiempo actual en segundos. La diferencia con el servidor de StarDots no puede exceder los 60 segundos. Nota: La zona horaria de StarDots es Asia/Singapore, que es UTC+8.
  • x-stardots-nonce
    Descripción
    Una cadena aleatoria de 4 a 20 caracteres, que solo puede contener letras mayúsculas, minúsculas y números. Ten en cuenta que este valor debe ser único dentro de los 60 segundos.
  • x-stardots-key
    Descripción
    Información de clave emitida por StarDots.
  • x-stardots-sign
    Descripción
    El campo de firma es una cadena generada combinando los campos anteriores de acuerdo con un algoritmo de firma determinado. El algoritmo de firma específico se presentará a continuación.

Algoritmo de firma

Asumimos los siguientes valores de campo

key
2dcded8e-f231-4d0a-8498-d10ef0639eb3
secret
Ey1JNRCiJOzaIOIilcyJvteTn5YXykFXUwmiHLymK8LHkITfGPo5mTUdLlg0jPHST9fMwMZKxIKUBvSsT5uxrq0lXuerll3eRW2tbMOsvySRY539L8cR6iRFV2DQqdlzbseyq7k9N0U5pZgj6f43e3MngbIttgSDl1G44IBOwqsI2HVXE5H6mf1bHlvWw6Ziuk8Xcw18AioG47SFBLIatrq6E9yEBJgFgcYysCH8JvY659hhqI3Ii1CA5zVtyNp
x-stardots-timestamp
1728958751
x-stardots-nonce
fQvDmMLnKE
x-stardots-key
2dcded8e-f231-4d0a-8498-d10ef0639eb3
La clave y el secreto son emitidos por StarDots, puedes encontrarlos en la página de configuración del consola.

Luego ensamblamos los valores de campo anteriores

needSignStr = x-stardots-timestamp + "|" + secret + "|" + x-stardots-nonce

A continuación, calculamos el resumen MD5 de la cadena ensamblada anteriormente

signStrAfterMD5 = md5("1728958751|Ey1JNRCiJOzaIOIilcyJvteTn5YXykFXUwmiHLymK8LHkITfGPo5mTUdLlg0jPHST9fMwMZKxIKUBvSsT5uxrq0lXuerll3eRW2tbMOsvySRY539L8cR6iRFV2DQqdlzbseyq7k9N0U5pZgj6f43e3MngbIttgSDl1G44IBOwqsI2HVXE5H6mf1bHlvWw6Ziuk8Xcw18AioG47SFBLIatrq6E9yEBJgFgcYysCH8JvY659hhqI3Ii1CA5zVtyNp|fQvDmMLnKE")
signStrAfterMD5 = "51dabfe4b47e73d4a3b85fe29c4f1e82"

Finalmente convertimos la cadena de resumen a mayúsculas

sign = signStrAfterMD5.toUpperCase()
sign = "51DABFE4B47E73D4A3B85FE29C4F1E82"

Por lo tanto, el valor final del campo x-stardots-sign es 51DABFE4B47E73D4A3B85FE29C4F1E82

Cuerpo de respuesta HTTP común

Todas las respuestas de la interfaz mantienen una estructura de datos unificada

  • code
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    Código de respuesta del servicio. 200 indica éxito.
  • message
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    Mensaje de resultado de la operación.
  • requestId
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    Un número único para la solicitud, que se puede usar para solucionar problemas.
  • success
    Tipo de dato
    booleano
    Requerido
    Sí
    Descripción
    Indica si la operación comercial fue exitosa.
  • ts
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    Marca de tiempo en milisegundos del servidor.
  • data
    Tipo de dato
    cualquier
    Requerido
    Sí
    Descripción
    Campo de datos comerciales. Este campo puede ser de cualquier tipo de datos. Para tipos de datos específicos, consulte la interfaz correspondiente.

Interfaz Funcional

Tenga en cuenta que todas las interfaces tendrán límites de tasa de solicitud, y todas las interfaces comparten un conjunto de reglas de límites de tasa. Hasta ahora, el límite de tasa de StarDots es de 300 veces por minuto.

Punto final de solicitud

https://api.stardots.io

Lista de Espacios

Obtén los datos de la lista de espacios.

Método de solicitud
GET
Ruta de solicitud
/openapi/space/list
Tipo de contenido de solicitud
application/json
Tipo de contenido de respuesta
application/json

Parámetros de solicitud

  • page
    Tipo de dato
    número
    Requerido
    No
    Descripción
    Número de página, el valor predeterminado es 1.
  • pageSize
    Tipo de dato
    número
    Requerido
    No
    Descripción
    El número de entradas por página varía de 1 a 100, y el valor predeterminado es 20.

Demo de solicitud

/openapi/space/list?page=1&pageSize=50

Campos de respuesta

  • name
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio.
  • public
    Tipo de dato
    booleano
    Requerido
    Sí
    Descripción
    Si la accesibilidad del espacio es falsa.
  • createdAt
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    La marca de tiempo del sistema en segundos cuando se creó el espacio. La zona horaria es UTC+8.
  • fileCount
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    El número de archivos en este espacio.

Demo de respuesta

{
    "code": 200,
    "data": [
        {
            "createdAt": 1723789637,
            "fileCount": 2,
            "name": "star",
            "public": true
        }
    ],
    "message": "SUCCESS",
    "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
    "success": true,
    "ts": 1670899688591
    }

Crear Espacio

Crea un nuevo espacio.

Método de solicitud
PUT
Ruta de solicitud
/openapi/space/create
Tipo de contenido de solicitud
application/json
Tipo de contenido de la respuesta
application/json

Parámetros de solicitud

  • space
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio. Solo puede ser una combinación de letras o números, y su longitud debe ser de 4 a 15 caracteres.
  • public
    Tipo de dato
    booleano
    Requerido
    No
    Descripción
    Especifica si el espacio es accesible públicamente. El valor predeterminado es falso.

Demo de solicitud

{
    "public": false,
    "space": "stardots"
    }

Campos de respuesta

Sin campos

Demostración de la respuesta

{
    "code": 200,
    "data": null,
    "message": "SUCCESS",
    "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
    "success": true,
    "ts": 1670899688591
    }

Eliminar Espacio

Elimina un espacio existente. Ten en cuenta que debes asegurarte de que no haya archivos en este espacio, de lo contrario, la eliminación fallará.

Método de solicitud
DELETE
Ruta de solicitud
/openapi/space/delete
Tipo de contenido de solicitud
application/json
Tipo de contenido de la respuesta
application/json

Parámetros de solicitud

  • space
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio. Solo puede ser una combinación de letras o números, y su longitud debe ser de 4 a 15 caracteres.

Demo de solicitud

{
    "space": "stardots"
    }

Campos de respuesta

Sin campos

Demostración de la respuesta

{
    "code": 200,
    "data": null,
    "message": "SUCCESS",
    "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
    "success": true,
    "ts": 1670899688591
    }

Accesibilidad del Espacio

Alternar la accesibilidad de un espacio.

Método de solicitud
POST
Ruta de solicitud
/openapi/space/accessibility/toggle
Tipo de contenido de solicitud
application/json
Tipo de contenido de la respuesta
application/json

Parámetros de solicitud

  • space
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio. Solo puede ser una combinación de letras o números, y su longitud debe ser de 4 a 15 caracteres.
  • public
    Tipo de dato
    booleano
    Requerido
    No
    Descripción
    Especifica si el espacio es accesible públicamente. El valor predeterminado es falso.

Demo de solicitud

{
    "public": false,
    "space": "stardots"
    }

Campos de respuesta

Sin campos

Demostración de la respuesta

{
    "code": 200,
    "data": null,
    "message": "SUCCESS",
    "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
    "success": true,
    "ts": 1670899688591
    }

Lista de Archivos en el Espacio

Obtén la lista de archivos en el espacio. La lista está ordenada en orden descendente según el tiempo de carga del archivo.

Método de solicitud
GET
Ruta de solicitud
/openapi/file/list
Tipo de contenido de solicitud
application/json
Tipo de contenido de la respuesta
application/json

Parámetros de solicitud

  • space
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio. Solo puede ser una combinación de letras o números, y la longitud es de 4 a 15 caracteres.
  • page
    Tipo de dato
    número
    Requerido
    No
    Descripción
    Número de página, el valor predeterminado es 1.
  • pageSize
    Tipo de dato
    número
    Requerido
    No
    Descripción
    El número de entradas por página varía de 1 a 100, y el valor predeterminado es 20.

Demo de solicitud

{
    "space": "stardots",
    "page": 1,
    "pageSize": 20,
    }

Campos de respuesta

  • page
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    Número de página, el valor predeterminado es 1.
  • pageSize
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    El número de entradas por página varía de 1 a 100, y el valor predeterminado es 20.
  • totalCount
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    El número total de entradas.
  • list
    Tipo de dato
    array<object>
    Requerido
    Sí
    Descripción
    Array de la lista de archivos.
  • list.name
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del archivo.
  • list.byteSize
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    El tamaño del archivo en bytes.
  • list.size
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    Tamaño del archivo, formateado para mayor legibilidad.
  • list.uploadedAt
    Tipo de dato
    número
    Requerido
    Sí
    Descripción
    El sello de tiempo de la carga del archivo en segundos. La zona horaria es UTC+8.
  • list.url
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    La dirección de acceso del archivo. Tenga en cuenta que si la accesibilidad del espacio es privada, este valor de campo llevará el ticket de acceso, que es válido durante 20 segundos.

Demostración de la respuesta

{
    "code": 0,
    "data": {
        "list": [
            {
                "byteSize": 3600000,
                "name": "star",
                "size": "35KB",
                "uploadedAt": 1723789637,
                "url": "https://....."
            }
        ],
        "page": 1,
        "pageSize": 10,
        "totalCount": 1
    },
    "message": "SUCCESS",
    "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
    "success": true,
    "ts": 1670899688591
    }

Ticket de acceso al archivo

Obtén el ticket de acceso para el archivo. Cuando la accesibilidad del espacio es privada, debes proporcionar el ticket de acceso para acceder a los archivos dentro del espacio, de lo contrario, la solicitud será rechazada.

Método de solicitud
POST
Ruta de solicitud
/openapi/file/ticket
Tipo de contenido de solicitud
application/json
Tipo de contenido de la respuesta
application/json

Parámetros de solicitud

  • space
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio. Solo puede ser una combinación de letras o números, y la longitud es de 4 a 15 caracteres.
  • filename
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del archivo.

Demo de solicitud

{
    "filename": "1.jpg",
    "space": "stardots"
    }

Campos de respuesta

  • ticket
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    Ticket de acceso.

Demostración de la respuesta

{
    "code": 200,
    "data": {
        "ticket": "a312.."
    },
    "message": "SUCCESS",
    "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
    "success": true,
    "ts": 1670899688591
    }

Subida de archivo

Sube el archivo al espacio. Ten en cuenta que esta solicitud requiere que inicies la solicitud en forma de formulario.

Método de solicitud
PUT
Ruta de solicitud
/openapi/file/upload
Tipo de contenido de solicitud
multipart/form-data
Tipo de contenido de la respuesta
application/json

Parámetros de solicitud

  • space
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio. Solo puede ser una combinación de letras o números, y la longitud es de 4 a 15 caracteres.
  • file
    Tipo de dato
    binario
    Requerido
    Sí
    Descripción
    El flujo binario del archivo. Ten en cuenta que el nombre del archivo no debe superar los 170 caracteres. El tamaño del archivo no puede exceder los 10MB.

Campos de respuesta

  • space
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio. Solo puede ser una combinación de letras o números, y la longitud es de 4 a 15 caracteres.
  • filename
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del archivo.
  • url
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El enlace de acceso al archivo. Si la accesibilidad del espacio es privada, el enlace de acceso llevará el ticket de acceso.

Demostración de la respuesta

{
    "code": 200,
    "data": {
        "filename": "1.png",
        "space": "space",
        "url": "https://i.stardots.io/space/1.png"
    },
    "message": "SUCCESS",
    "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
    "success": true,
    "ts": 1670899688591
    }

Eliminar archivos

Elimina archivos en el espacio. Esta interfaz admite operaciones en lote.

Método de solicitud
DELETE
Ruta de solicitud
/openapi/file/delete
Tipo de contenido de solicitud
application/json
Tipo de contenido de la respuesta
application/json

Parámetros de solicitud

  • space
    Tipo de dato
    cadena
    Requerido
    Sí
    Descripción
    El nombre del espacio. Solo puede ser una combinación de letras o números, y la longitud es de 4 a 15 caracteres.
  • filenameList
    Tipo de dato
    array<string>
    Requerido
    Sí
    Descripción
    Arreglo de nombres de archivos.

Demo de solicitud

{
    "filenameList": ["1.jpg", "2.jpg"],
    "space": "stardots"
    }

Campos de respuesta

Sin campos

Demostración de la respuesta

{
    "code": 0,
    "data": null,
    "message": "SUCCESS",
    "requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
    "success": true,
    "ts": 1670899688591
    }

Códigos de respuesta del servidor

Los códigos de respuesta del servidor son códigos de respuesta que el servidor devuelve al cliente para representar el resultado del procesamiento de una solicitud.

  • 200
    Descripción
    Éxito
  • 504
    Descripción
    La solicitud excedió el plazo
  • 999999
    Descripción
    Error interno del servidor
  • 100000
    Descripción
    Error de parámetro de solicitud
  • 100001
    Descripción
    Acceso-ticket expirado
  • 100002
    Descripción
    Verificación persona-máquina no pasó
  • 100003
    Descripción
    Código de verificación incorrecto
  • 100004
    Descripción
    Cuenta no existe
  • 100005
    Descripción
    Contraseña de la cuenta no coincide
  • 100006
    Descripción
    Plano de suscripción no existe
  • 100007
    Descripción
    SMS/E-mail enviados con demasiada frecuencia
  • 100008
    Descripción
    SMS/E-mail enviados con demasiada frecuencia
  • 100009
    Descripción
    Raum/Speicher nicht existiert
  • 100010
    Descripción
    Raum/Speicher existiert
  • 100011
    Descripción
    Raum/Speicher nicht leer
  • 100012
    Descripción
    Operaciones muy frecuentes
  • 100013
    Descripción
    Raum/Speicher-Anzahl-Kontingent erreicht
  • 100014
    Descripción
    Raum/Speicher-Anzahl-Kontingent erreicht
  • 100015
    Descripción
    Raum/Speicher-Datenübertragungskontingent erschöpft
  • 100016
    Descripción
    Plano de suscripción no coincide
  • 100017
    Descripción
    Raum/Speicher-Dateizugriff eingeschränkt
  • 100018
    Descripción
    Archivo excede el límite de tamaño
  • 100019
    Descripción
    Formato de archivo no soportado
  • 100020
    Descripción
    Referer no está permitido
  • 100021
    Descripción
    Funciones disponibles solo para usuarios Pro o Premium
  • 100022
    Descripción
    Funciones disponibles solo para usuarios Premium
  • 100023
    Descripción
    Certificado de contenido inválido
  • 100024
    Descripción
    Certificado y clave privada no coinciden
  • 100025
    Descripción
    Tipo de MIME de imagen inválido
  • 100026
    Descripción
    El enlace de acceso al archivo ha expirado
  • 100027
    Descripción
    API llamadas alcanzaron el límite
  • 100028
    Descripción
    Operaciones en lote disponibles solo para usuarios pagantes
  • 100029
    Descripción
    El enlace de imagen es inválido
  • 100030
    Descripción
    Cuenta sospechosa de violación, se ha prohibido el acceso

SDK

StarDots proporciona SDKs para varios lenguajes de programación para ayudarte a integrar rápidamente con nuestra API. Puedes encontrar los SDKs en los siguientes enlaces:

Si encuentras algún problema, por favor contáctanos