StarDots.io Logo

StarDots

Accueil de la documentation

Open API

Ce chapitre expliquera comment intégrer les API ouvertes. Les connaissances suivantes sont destinées aux développeurs, et nous supposons que vous avez une certaine base en programmation.

Vous êtes un agent IA ? Consultez la documentation Markdown
Sur cette page

Authentification

StarDots effectue l'authentification en lisant le champ des en-têtes dans la requête HTTP initiée par le client et en vérifiant les champs correspondants. Par conséquent, toutes les requêtes d'API ouvertes doivent contenir ces informations de champ d'authentification, et vous devez noter que ces champs sont sensibles à la casse et que tous les champs doivent être en minuscules.

  • x-stardots-timestamp
    Description
    Horodatage actuel en secondes. La différence avec le serveur StarDots ne doit pas dépasser 60 secondes. Note : Le fuseau horaire de StarDots est Asia/Singapore, UTC+8.
  • x-stardots-nonce
    Description
    Une chaîne aléatoire de 4 à 20 caractères, qui ne peut contenir que des lettres majuscules, des lettres minuscules et des chiffres. Notez que cette valeur doit être unique dans un délai de 60 secondes.
  • x-stardots-key
    Description
    Informations clés émises par StarDots.
  • x-stardots-sign
    Description
    Le champ de signature est une chaîne générée en combinant les champs ci-dessus selon un certain algorithme de signature. L'algorithme de signature spécifique sera introduit ensuite.

Algorithme de signature

Nous supposons les valeurs de champ suivantes

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 clé et le secret sont émis par StarDots, vous pouvez les trouver dans la page des paramètres de la console.

Nous assemblons ensuite les valeurs de champ ci-dessus

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

Ensuite, nous calculons le hachage MD5 de la chaîne assemblée ci-dessus

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

Enfin, nous convertissons la chaîne résumée en majuscules

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

Par conséquent, la valeur finale du champ x-stardots-sign est 51DABFE4B47E73D4A3B85FE29C4F1E82

Corps de réponse HTTP commun

Toutes les réponses des interfaces maintiennent une structure de données unifiée

  • code
    Type de données
    number
    Requis
    Oui
    Description
    Code de réponse du service. 200 indique un succès.
  • message
    Type de données
    string
    Requis
    Oui
    Description
    Message indiquant le résultat de l'opération.
  • requestId
    Type de données
    string
    Requis
    Oui
    Description
    Numéro unique pour la requête, qui peut être utilisé pour le dépannage.
  • success
    Type de données
    boolean
    Requis
    Oui
    Description
    Indique si l'opération commerciale a réussi.
  • ts
    Type de données
    number
    Requis
    Oui
    Description
    Horodatage en millisecondes du serveur.
  • data
    Type de données
    any
    Requis
    Oui
    Description
    Champ de données métier. Ce champ peut être de n'importe quel type de données. Pour les types de données spécifiques, veuillez vous référer à l'interface correspondante.

Interface fonctionnelle

Notez que toutes les interfaces auront des limites de taux de requêtes, et toutes les interfaces partagent un ensemble de règles de limitation de taux. Jusqu'à présent, la limite de taux de StarDots est de 300 fois par minute.

Point de terminaison de la requête

https://api.stardots.io

Liste des espaces

Obtenez les données de la liste des espaces.

Méthode de la requête
GET
Chemin de la requête
/openapi/space/list
Type de contenu de la requête
application/json
Type de contenu de la réponse
application/json

Paramètres de la requête

  • page
    Type de données
    number
    Requis
    Non
    Description
    Numéro de la page, la valeur par défaut est 1.
  • pageSize
    Type de données
    number
    Requis
    Non
    Description
    Le nombre d'entrées par page varie de 1 à 100, et la valeur par défaut est 20.

Démonstration de la requête

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

Champs de la réponse

  • name
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace.
  • public
    Type de données
    boolean
    Requis
    Oui
    Description
    Indique si l'accessibilité de l'espace est privée.
  • createdAt
    Type de données
    number
    Requis
    Oui
    Description
    L'horodatage système en secondes lorsque l'espace a été créé. Le fuseau horaire est UTC+8.
  • fileCount
    Type de données
    number
    Requis
    Oui
    Description
    Le nombre de fichiers dans cet espace.

Démonstration de la réponse

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

Créer un espace

Créez un nouvel espace.

Méthode de la requête
PUT
Chemin de la requête
/openapi/space/create
Type de contenu de la requête
application/json
Type de contenu de la réponse
application/json

Paramètres de la requête

  • space
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace. Il ne peut contenir que des lettres ou des chiffres, et sa longueur est de 4 à 15 caractères.
  • public
    Type de données
    boolean
    Requis
    Non
    Description
    Indique si l'espace est accessible publiquement. La valeur par défaut est fausse.

Démonstration de la requête

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

Champs de la réponse

Aucun champ

Démo de la réponse

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

Supprimer un espace

Supprimez un espace existant. Notez que vous devez vous assurer qu'il n'y a pas de fichiers dans cet espace, sinon la suppression échouera.

Méthode de la requête
DELETE
Chemin de la requête
/openapi/space/delete
Type de contenu de la requête
application/json
Type de contenu de la réponse
application/json

Paramètres de la requête

  • space
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace. Il ne peut contenir que des lettres ou des chiffres, et sa longueur est de 4 à 15 caractères.

Démonstration de la requête

{
    "space": "stardots"
    }

Champs de la réponse

Aucun champ

Démo de la réponse

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

Accessibilité de l'espace

Basculez l'accessibilité d'un espace.

Méthode de la requête
POST
Chemin de la requête
/openapi/space/accessibility/toggle
Type de contenu de la requête
application/json
Type de contenu de la réponse
application/json

Paramètres de la requête

  • space
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace. Il ne peut contenir que des lettres ou des chiffres, et sa longueur est de 4 à 15 caractères.
  • public
    Type de données
    boolean
    Requis
    Non
    Description
    Spécifie si l'espace est accessible publiquement. La valeur par défaut est false.

Démonstration de la requête

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

Champs de la réponse

Aucun champ

Démo de la réponse

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

Liste des fichiers dans l'espace

Obtenez la liste des fichiers dans l'espace. La liste est triée par ordre décroissant en fonction du temps de téléchargement des fichiers.

Méthode de la requête
GET
Chemin de la requête
/openapi/file/list
Type de contenu de la requête
application/json
Type de contenu de la réponse
application/json

Paramètres de la requête

  • space
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace. Il ne peut contenir que des lettres ou des chiffres, et sa longueur est de 4 à 15 caractères.
  • page
    Type de données
    number
    Requis
    Non
    Description
    Numéro de la page, la valeur par défaut est 1.
  • pageSize
    Type de données
    number
    Requis
    Non
    Description
    Le nombre d'éléments par page varie de 1 à 100, et la valeur par défaut est 20.

Démonstration de la requête

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

Champs de la réponse

  • page
    Type de données
    number
    Requis
    Oui
    Description
    Numéro de la page, la valeur par défaut est 1.
  • pageSize
    Type de données
    number
    Requis
    Oui
    Description
    Le nombre d'éléments par page varie de 1 à 100, et la valeur par défaut est 20.
  • totalCount
    Type de données
    number
    Requis
    Oui
    Description
    Le nombre total d'éléments.
  • list
    Type de données
    array<object>
    Requis
    Oui
    Description
    Tableau de la liste des fichiers.
  • list.name
    Type de données
    string
    Requis
    Oui
    Description
    Le nom du fichier.
  • list.byteSize
    Type de données
    number
    Requis
    Oui
    Description
    La taille du fichier en octets.
  • list.size
    Type de données
    string
    Requis
    Oui
    Description
    Taille du fichier, formatée pour la lisibilité.
  • list.uploadedAt
    Type de données
    number
    Requis
    Oui
    Description
    L'horodatage du téléchargement du fichier en secondes. Le fuseau horaire est UTC+8.
  • list.url
    Type de données
    string
    Requis
    Oui
    Description
    L'adresse d'accès du fichier. Notez que si l'accessibilité de l'espace est privée, cette valeur de champ contiendra le ticket d'accès, valable pendant 20 secondes.

Démo de la réponse

{
    "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 d'accès au fichier

Obtenez le ticket d'accès pour le fichier. Lorsque l'accessibilité de l'espace est privée, vous devez apporter le ticket d'accès pour accéder aux fichiers de l'espace, sinon la requête sera rejetée.

Méthode de la requête
POST
Chemin de la requête
/openapi/file/ticket
Type de contenu de la requête
application/json
Type de contenu de la réponse
application/json

Paramètres de la requête

  • space
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace. Il ne peut contenir que des lettres ou des chiffres, et sa longueur doit être comprise entre 4 et 15 caractères.
  • filename
    Type de données
    string
    Requis
    Oui
    Description
    Le nom du fichier.

Démonstration de la requête

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

Champs de la réponse

  • ticket
    Type de données
    string
    Requis
    Oui
    Description
    Ticket d'accès.

Démo de la réponse

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

Téléchargement de fichier

Téléchargez le fichier dans l'espace. Notez que cette requête nécessite que vous initiiez la requête sous forme de formulaire.

Méthode de la requête
PUT
Chemin de la requête
/openapi/file/upload
Type de contenu de la requête
multipart/form-data
Type de contenu de la réponse
application/json

Paramètres de la requête

  • space
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace. Il ne peut contenir que des lettres ou des chiffres, et sa longueur doit être comprise entre 4 et 15 caractères.
  • file
    Type de données
    binary
    Requis
    Oui
    Description
    Le flux binaire du fichier. Notez que le nom du fichier ne doit pas dépasser 170 caractères. La taille du fichier ne doit pas dépasser 10 Mo.

Champs de la réponse

  • space
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace. Il ne peut contenir que des lettres ou des chiffres, et sa longueur doit être comprise entre 4 et 15 caractères.
  • filename
    Type de données
    string
    Requis
    Oui
    Description
    Le nom du fichier.
  • url
    Type de données
    string
    Requis
    Oui
    Description
    Le lien d'accès du fichier. Si l'accessibilité de l'espace est privée, le lien d'accès contiendra le ticket d'accès.

Démo de la réponse

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

Supprimer des fichiers

Supprimez des fichiers dans l'espace. Cette interface prend en charge les opérations par lots.

Méthode de la requête
DELETE
Chemin de la requête
/openapi/file/delete
Type de contenu de la requête
application/json
Type de contenu de la réponse
application/json

Paramètres de la requête

  • space
    Type de données
    string
    Requis
    Oui
    Description
    Le nom de l'espace. Il ne peut contenir que des lettres ou des chiffres, et sa longueur doit être comprise entre 4 et 15 caractères.
  • filenameList
    Type de données
    array<string>
    Requis
    Oui
    Description
    Liste des noms de fichiers.

Démonstration de la requête

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

Champs de la réponse

Aucun champ

Démo de la réponse

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

Codes de réponse du serveur

Les codes de réponse du serveur sont des codes de réponse que le serveur renvoie au client pour représenter le résultat du traitement d'une requête.

  • 200
    Description
    Succès
  • 504
    Description
    La requête a dépassé le délai
  • 999999
    Description
    Erreur interne du serveur
  • 100000
    Description
    Erreur de paramètre de requête
  • 100001
    Description
    Accès-ticket expiré
  • 100002
    Description
    Personne-machine-vérification non réussie
  • 100003
    Description
    Code de vérification incorrect
  • 100004
    Description
    Compte non existant
  • 100005
    Description
    Mot de passe du compte incorrect
  • 100006
    Description
    Abonnementplan non existant
  • 100007
    Description
    SMS/E-Mail-Sendungen zu häufig
  • 100008
    Description
    SMS/E-Mail-Sendungen zu häufig
  • 100009
    Description
    Raum/Speicher nicht existant
  • 100010
    Description
    Raum/Speicher existant
  • 100011
    Description
    Raum/Speicher nicht leer
  • 100012
    Description
    Opérations trop fréquentes
  • 100013
    Description
    Raum/Speicher-Anzahl-Kontingent erreicht
  • 100014
    Description
    Dateinummer-Kontingent erreicht
  • 100015
    Description
    Datenübertragungskontingent erschöpft
  • 100016
    Description
    Abonnementplan nicht übereinstimmt
  • 100017
    Description
    Raum/Speicher-Dateizugriff eingeschränkt
  • 100018
    Description
    Datei überschreitet die Größenbeschränkung
  • 100019
    Description
    Dateiformat nicht unterstützt
  • 100020
    Description
    Referer nicht erlaubt
  • 100021
    Description
    Funktionen nur für Pro- oder Premium-Benutzer verfügbar
  • 100022
    Description
    Funktionen nur für Premium-Benutzer verfügbar
  • 100023
    Description
    Zertifikatinhalt ungültig
  • 100024
    Description
    Zertifikat und privater Schlüssel stimmen nicht überein
  • 100025
    Description
    Bild-MIME-Typ ungültig
  • 100026
    Description
    Dateizugriffslink abgelaufen
  • 100027
    Description
    API-Aufrufe erreichten die Obergrenze
  • 100028
    Description
    Opérations par lots uniquement pour les utilisateurs payants
  • 100029
    Description
    Image-Link ungültig
  • 100030
    Description
    Compte suspect de violation, a été interdit de connexion

SDK

StarDots fournit des SDKs pour différents langages de programmation pour vous aider à intégrer rapidement notre API. Vous pouvez trouver les SDKs dans les liens suivants :

Si vous rencontrez des problèmes, veuillez nous contacter