StarDots.io Logo

StarDots

Início da documentação

API Aberta

Este capítulo irá apresentar como integrar APIs abertas. O conhecimento a seguir é para desenvolvedores, e assumimos que você tem uma certa base em programação.

É um agente de IA? Consulte a documentação em Markdown
Nesta página

Autenticação

O StarDots realiza a autenticação lendo o campo de cabeçalhos na solicitação HTTP iniciada pelo cliente e verificando os campos relevantes. Portanto, todas as solicitações de API aberta devem carregar essas informações de campo de autenticação, e você precisa observar que esses campos são sensíveis a maiúsculas e minúsculas, e todos os campos devem ser em letras minúsculas.

  • x-stardots-timestamp
    Descrição
    Carimbo de tempo atual em segundos. A diferença com o servidor StarDots não pode exceder 60 segundos. Nota: O fuso horário do StarDots é Asia/Singapore, que é UTC+8.
  • x-stardots-nonce
    Descrição
    Uma string aleatória de 4 a 20 caracteres, que pode conter apenas letras maiúsculas, letras minúsculas e números. Nota: Este valor deve ser único dentro de 60 segundos.
  • x-stardots-key
    Descrição
    Informações da chave emitida pelo StarDots.
  • x-stardots-sign
    Descrição
    O campo de assinatura é uma string gerada combinando os campos acima de acordo com um determinado algoritmo de assinatura. O algoritmo de assinatura específico será introduzido a seguir.

Algoritmo de Assinatura

Assumimos os seguintes 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
A chave e o segredo são emitidos pelo StarDots, você pode encontrá-los na página de configurações do console.

Em seguida, montamos os valores dos campos acima

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

A seguir, calculamos o resumo MD5 da string montada acima

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

Por fim, convertemos a string de resumo para maiúsculas

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

Portanto, o valor final do campo x-stardots-sign é 51DABFE4B47E73D4A3B85FE29C4F1E82

Corpo de resposta HTTP comum

Todas as respostas de interface mantêm uma estrutura de dados unificada

  • code
    Tipo de dado
    número
    Obrigatório
    Sim
    Descrição
    Código de resposta do serviço. 200 indica sucesso.
  • message
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    Mensagem do resultado da operação.
  • requestId
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    Número único para a solicitação, que pode ser usado para solução de problemas.
  • success
    Tipo de dado
    booleano
    Obrigatório
    Sim
    Descrição
    Indica se a operação de negócios foi bem-sucedida.
  • ts
    Tipo de dado
    número
    Obrigatório
    Sim
    Descrição
    Carimbo de tempo em milissegundos do servidor.
  • data
    Tipo de dado
    qualquer
    Obrigatório
    Sim
    Descrição
    Campo de dados de negócios. Este campo pode ser de qualquer tipo de dado. Para tipos de dados específicos, consulte a interface correspondente.

Interface Funcional

Observe que todas as interfaces terão limites de taxa de solicitação, e todas as interfaces compartilham um conjunto de regras de limite de taxa. Até agora, o limite de taxa do StarDots é de 300 vezes por minuto.

Ponto de solicitação

https://api.stardots.io

Lista de Espaços

Obter dados da lista de espaços.

Método da solicitação
GET
Caminho da solicitação
/openapi/space/list
Tipo de conteúdo da solicitação
application/json
Tipo de conteúdo da resposta
application/json

Parâmetros da solicitação

  • page
    Tipo de dado
    número
    Obrigatório
    Não
    Descrição
    Número da página, o valor padrão é 1.
  • pageSize
    Tipo de dado
    número
    Obrigatório
    Não
    Descrição
    O número de entradas por página varia de 1 a 100, e o valor padrão é 20.

Demonstração da solicitação

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

Campos da resposta

  • name
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço.
  • public
    Tipo de dado
    booleano
    Obrigatório
    Sim
    Descrição
    Se a acessibilidade do espaço for falsa.
  • createdAt
    Tipo de dado
    número
    Obrigatório
    Sim
    Descrição
    O carimbo de data/hora do sistema em segundos quando o espaço foi criado. O fuso horário é UTC+8.
  • fileCount
    Tipo de dado
    número
    Obrigatório
    Sim
    Descrição
    O número de arquivos neste espaço.

Demonstração da resposta

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

Criar Espaço

Criar um novo espaço.

Método da solicitação
PUT
Caminho da solicitação
/openapi/space/create
Tipo de conteúdo da solicitação
application/json
Tipo de conteúdo da resposta
application/json

Parâmetros da solicitação

  • space
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço. Pode ser apenas uma combinação de letras ou números, e o comprimento deve ser de 4 a 15 caracteres.
  • public
    Tipo de dado
    booleano
    Obrigatório
    Não
    Descrição
    Especifica se o espaço é acessível publicamente. O valor padrão é falso.

Demonstração da solicitação

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

Campos da resposta

Sem campos

Demonstração da resposta

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

Excluir Espaço

Excluir um espaço existente. Observe que você deve garantir que não haja arquivos neste espaço, caso contrário, a exclusão falhará.

Método da solicitação
DELETE
Caminho da solicitação
/openapi/space/delete
Tipo de conteúdo da solicitação
application/json
Tipo de conteúdo da resposta
application/json

Parâmetros da solicitação

  • space
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço. Pode ser apenas uma combinação de letras ou números, e o comprimento deve ser de 4 a 15 caracteres.

Demonstração da solicitação

{
    "space": "stardots"
    }

Campos da resposta

Sem campos

Demonstração da resposta

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

Acessibilidade do Espaço

Alternar a acessibilidade de um espaço.

Método da solicitação
POST
Caminho da solicitação
/openapi/space/accessibility/toggle
Tipo de conteúdo da solicitação
application/json
Tipo de conteúdo da resposta
application/json

Parâmetros da solicitação

  • space
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço. Pode ser apenas uma combinação de letras ou números, e o comprimento deve ser de 4 a 15 caracteres.
  • public
    Tipo de dado
    boolean
    Obrigatório
    Não
    Descrição
    Especifica se o espaço é acessível publicamente. O valor padrão é falso.

Demonstração da solicitação

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

Campos da resposta

Sem campos

Demonstração da resposta

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

Lista de arquivos no espaço

Obtenha a lista de arquivos no espaço. A lista é ordenada em ordem decrescente pelo tempo de upload do arquivo.

Método da solicitação
GET
Caminho da solicitação
/openapi/file/list
Tipo de conteúdo da solicitação
application/json
Tipo de conteúdo da resposta
application/json

Parâmetros da solicitação

  • space
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço. Pode ser apenas uma combinação de letras ou números, e o comprimento deve ser de 4 a 15 caracteres.
  • page
    Tipo de dado
    number
    Obrigatório
    Não
    Descrição
    Número da página, valor padrão é 1.
  • pageSize
    Tipo de dado
    number
    Obrigatório
    Não
    Descrição
    O número de entradas por página varia de 1 a 100, e o valor padrão é 20.

Demonstração da solicitação

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

Campos da resposta

  • page
    Tipo de dado
    number
    Obrigatório
    Sim
    Descrição
    Número da página, valor padrão é 1.
  • pageSize
    Tipo de dado
    number
    Obrigatório
    Sim
    Descrição
    O número de entradas por página varia de 1 a 100, e o valor padrão é 20.
  • totalCount
    Tipo de dado
    number
    Obrigatório
    Sim
    Descrição
    O número total de entradas.
  • list
    Tipo de dado
    array<object>
    Obrigatório
    Sim
    Descrição
    Array da lista de arquivos.
  • list.name
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do arquivo.
  • list.byteSize
    Tipo de dado
    number
    Obrigatório
    Sim
    Descrição
    O tamanho do arquivo em bytes.
  • list.size
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    Tamanho do arquivo, formatado para legibilidade.
  • list.uploadedAt
    Tipo de dado
    number
    Obrigatório
    Sim
    Descrição
    O timestamp do upload do arquivo em segundos. O fuso horário é UTC+8.
  • list.url
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O endereço de acesso do arquivo. Observe que, se a acessibilidade do espaço for privada, o valor deste campo incluirá o bilhete de acesso, que é válido por 20 segundos.

Demonstração da resposta

{
    "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
    }

Bilhete de acesso ao arquivo

Obtenha o bilhete de acesso ao arquivo. Quando a acessibilidade do espaço for privada, você precisará fornecer o bilhete de acesso para acessar os arquivos dentro do espaço, caso contrário, a solicitação será rejeitada.

Método da solicitação
POST
Caminho da solicitação
/openapi/file/ticket
Tipo de conteúdo da solicitação
application/json
Tipo de conteúdo da resposta
application/json

Parâmetros da solicitação

  • space
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço. Pode ser apenas uma combinação de letras ou números, e o comprimento deve ser de 4 a 15 caracteres.
  • filename
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do arquivo.

Demonstração da solicitação

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

Campos da resposta

  • ticket
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    Bilhete de acesso.

Demonstração da resposta

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

Envio de arquivo

Envie o arquivo para o espaço. Observe que essa solicitação exige que você inicie a solicitação no formato de um formulário.

Método da solicitação
PUT
Caminho da solicitação
/openapi/file/upload
Tipo de conteúdo da solicitação
multipart/form-data
Tipo de conteúdo da resposta
application/json

Parâmetros da solicitação

  • space
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço. Pode ser apenas uma combinação de letras ou números, e o comprimento deve ser de 4 a 15 caracteres.
  • file
    Tipo de dado
    binary
    Obrigatório
    Sim
    Descrição
    O fluxo binário do arquivo. Observe que o nome do arquivo não pode exceder 170 caracteres. O tamanho do arquivo não pode exceder 10MB.

Campos da resposta

  • space
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço. Pode ser apenas uma combinação de letras ou números, e o comprimento deve ser de 4 a 15 caracteres.
  • filename
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do arquivo.
  • url
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O link de acesso ao arquivo. Se a acessibilidade do espaço for privada, o link de acesso conterá o bilhete de acesso.

Demonstração da resposta

{
    "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
    }

Excluir arquivos

Exclua arquivos no espaço. Esta interface suporta operações em lote.

Método da solicitação
DELETE
Caminho da solicitação
/openapi/file/delete
Tipo de conteúdo da solicitação
application/json
Tipo de conteúdo da resposta
application/json

Parâmetros da solicitação

  • space
    Tipo de dado
    string
    Obrigatório
    Sim
    Descrição
    O nome do espaço. Pode ser apenas uma combinação de letras ou números, e o comprimento deve ser de 4 a 15 caracteres.
  • filenameList
    Tipo de dado
    array<string>
    Obrigatório
    Sim
    Descrição
    Lista de nomes de arquivos.

Demonstração da solicitação

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

Campos da resposta

Sem campos

Demonstração da resposta

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

Códigos de resposta do servidor

Os códigos de resposta do servidor são códigos de resposta que o servidor retorna ao cliente para representar o resultado do processamento de uma solicitação.

  • 200
    Descrição
    Sucesso
  • 504
    Descrição
    A solicitação excedeu o prazo
  • 999999
    Descrição
    Erro interno do servidor
  • 100000
    Descrição
    Erro de parâmetro de solicitação
  • 100001
    Descrição
    Acesso-ticket expirado
  • 100002
    Descrição
    Verificação pessoa-máquina não passou
  • 100003
    Descrição
    Código de verificação incorreto
  • 100004
    Descrição
    Conta não existe
  • 100005
    Descrição
    Senha da conta não corresponde
  • 100006
    Descrição
    Plano de assinatura não existe
  • 100007
    Descrição
    SMS/E-mail enviados com frequência excessiva
  • 100008
    Descrição
    SMS/E-mail enviados com frequência excessiva
  • 100009
    Descrição
    Raum/Speicher nicht existiert
  • 100010
    Descrição
    Raum/Speicher existiert
  • 100011
    Descrição
    Raum/Speicher nicht leer
  • 100012
    Descrição
    Operações muito frequentes
  • 100013
    Descrição
    Raum/Speicher-Anzahl-Kontingent erreicht
  • 100014
    Descrição
    Raum/Speicher-Anzahl-Kontingent erreicht
  • 100015
    Descrição
    Raum/Speicher-Datenübertragungskontingent erschöpft
  • 100016
    Descrição
    Plano de assinatura não corresponde
  • 100017
    Descrição
    Raum/Speicher-Dateizugriff eingeschränkt
  • 100018
    Descrição
    Arquivo excede o limite de tamanho
  • 100019
    Descrição
    Formato de arquivo não suportado
  • 100020
    Descrição
    Referer não permitido
  • 100021
    Descrição
    Funções disponíveis apenas para usuários Pro ou Premium
  • 100022
    Descrição
    Funções disponíveis apenas para usuários Premium
  • 100023
    Descrição
    Certificado de conteúdo inválido
  • 100024
    Descrição
    Certificado e chave privada não correspondem
  • 100025
    Descrição
    Tipo de MIME de imagem inválido
  • 100026
    Descrição
    Link de acesso ao arquivo expirado
  • 100027
    Descrição
    API chamadas atingiram o limite
  • 100028
    Descrição
    Operações em lote disponíveis apenas para usuários pagantes
  • 100029
    Descrição
    Link de imagem inválido
  • 100030
    Descrição
    Conta suspeita de violação, foi proibida acesso

SDK

O StarDots fornece SDKs para várias linguagens de programação para ajudá-lo a integrar rapidamente com nossa API. Você pode encontrar os SDKs nos seguintes links:

Se você encontrar algum problema, por favor, entre em contato conosco