StarDots.io Logo

StarDots

Zur Dokumentationsübersicht

Open API

Dieses Kapitel erklärt, wie man Open APIs integriert. Das folgende Wissen richtet sich an Entwickler, und wir gehen davon aus, dass Sie über grundlegende Programmierkenntnisse verfügen.

Sie sind ein KI-Agent? Dokumentation als Markdown lesen
Auf dieser Seite

Authentifizierung

StarDots führt die Authentifizierung durch, indem es das Header-Feld in der HTTP-Anfrage des Clients liest und die entsprechenden Felder überprüft. Daher sollten alle Open API-Anfragen diese Authentifizierungsfeldinformationen enthalten. Beachten Sie, dass diese Felder case-sensitiv sind und alle Felder in Kleinbuchstaben angegeben werden müssen.

  • x-stardots-timestamp
    Beschreibung
    Aktueller Zeitstempel in Sekunden. Die Differenz zum StarDots-Server darf 60 Sekunden nicht überschreiten. Hinweis: Die Zeitzone von StarDots ist Asia/Singapore, also UTC+8.
  • x-stardots-nonce
    Beschreibung
    Ein zufälliger String mit 4 bis 20 Zeichen, der nur aus Großbuchstaben, Kleinbuchstaben und Zahlen bestehen darf. Beachten Sie, dass dieser Wert innerhalb von 60 Sekunden einzigartig sein muss.
  • x-stardots-key
    Beschreibung
    Schlüsselinformationen, die von StarDots ausgestellt werden.
  • x-stardots-sign
    Beschreibung
    Das Signaturfeld ist ein String, der durch Kombinieren der oben genannten Felder nach einem bestimmten Signaturalgorithmus generiert wird. Der spezifische Signaturalgorithmus wird im nächsten Abschnitt eingeführt.

Signaturalgorithmus

Wir nehmen die folgenden Feldwerte an

key
2dcded8e-f231-4d0a-8498-d10ef0639eb3
secret
Ey1JNRCiJOzaIOIilcyJvteTn5YXykFXUwmiHLymK8LHkITfGPo5mTUdLlg0jPHST9fMwMZKxIKUBvSsT5uxrq0lXuerll3eRW2tbMOsvySRY539L8cR6iRFV2DQqdlzbseyq7k9N0U5pZgj6f43e3MngbIttgSDl1G44IBOwqsI2HVXE5H6mf1bHlvWw6Ziuk8Xcw18AioG47SFBLIatrq6E9yEBJgFgcYysCH8JvY659hhqI3Ii1CA5zVtyNp
x-stardots-timestamp
1728958751
x-stardots-nonce
fQvDmMLnKE
x-stardots-key
2dcded8e-f231-4d0a-8498-d10ef0639eb3
Schlüssel und Geheimnis werden von StarDots ausgestellt, Sie finden sie auf der Seite der Konsoleneinstellungen.

Dann kombinieren wir die oben genannten Feldwerte

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

Als nächstes berechnen wir den MD5-Hash der oben kombinierten Zeichenkette

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

Schließlich konvertieren wir die zusammengefasste Zeichenkette in Großbuchstaben

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

Daher ist der endgültige Wert des x-stardots-sign-Feldes 51DABFE4B47E73D4A3B85FE29C4F1E82

Gemeinsamer HTTP-Antwortkörper

Alle Schnittstellenantworten behalten eine einheitliche Datenstruktur bei

  • code
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Antwortcode des Dienstes. 200 zeigt Erfolg an.
  • message
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Nachricht mit dem Ergebnis der Operation.
  • requestId
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Eine eindeutige Nummer für die Anfrage, die zur Fehlerbehebung verwendet werden kann.
  • success
    Daten Typ
    boolean
    Erforderlich
    Ja
    Beschreibung
    Gibt an, ob die Geschäftsoperation erfolgreich war.
  • ts
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Server-Zeitstempel in Millisekunden.
  • data
    Daten Typ
    any
    Erforderlich
    Ja
    Beschreibung
    Geschäftsdatenfeld. Dieses Feld kann jeden Datentyp haben. Für spezifische Datentypen konsultieren Sie bitte die entsprechende Schnittstelle.

Funktionales Interface

Beachten Sie, dass alle Schnittstellen Anforderungsratenbegrenzungen haben, und alle Schnittstellen teilen sich ein Set von Regeln zur Ratenbegrenzung. Bis jetzt liegt das Ratenlimit von StarDots bei 300 Anfragen pro Minute.

Anforderungsendpunkt

https://api.stardots.io

Raum Liste

Holen Sie sich die Daten der Raumliste.

Anfragemethode
GET
Anforderungsweg
/openapi/space/list
Anforderungsinhalts-Typ
application/json
Antwortinhaltstyp
application/json

Anforderungsparameter

  • page
    Daten Typ
    number
    Erforderlich
    Nein
    Beschreibung
    Seitennummer, Standardwert ist 1.
  • pageSize
    Daten Typ
    number
    Erforderlich
    Nein
    Beschreibung
    Die Anzahl der Einträge pro Seite reicht von 1 bis 100, der Standardwert ist 20.

Anforderungsdemo

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

Antwortfelder

  • name
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums.
  • public
    Daten Typ
    boolean
    Erforderlich
    Ja
    Beschreibung
    Ob die Zugänglichkeit des Raums falsch ist.
  • createdAt
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Der Systemzeitstempel in Sekunden, als der Raum erstellt wurde. Die Zeitzone ist UTC+8.
  • fileCount
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Die Anzahl der Dateien in diesem Raum.

Antwortdemo

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

Raum erstellen

Erstellen Sie einen neuen Raum.

Anforderungsmethode
PUT
Anforderungs-Pfad
/openapi/space/create
Anforderung Inhaltstyp
application/json
Antwortinhaltstyp
application/json

Anforderungsparameter

  • space
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums. Er kann nur aus Buchstaben oder Zahlen bestehen und die Länge beträgt 4 bis 15 Zeichen.
  • public
    Daten Typ
    boolean
    Erforderlich
    Nein
    Beschreibung
    Gibt an, ob der Raum öffentlich zugänglich ist. Der Standardwert ist false.

Anforderungsdemo

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

Antwortfelder

Keine Felder

Antwortdemo

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

Raum löschen

Löschen Sie einen bestehenden Raum. Beachten Sie, dass Sie sicherstellen müssen, dass keine Dateien in diesem Raum vorhanden sind, andernfalls schlägt das Löschen fehl.

Anforderungsmethode
DELETE
Anforderungs-Pfad
/openapi/space/delete
Anforderung Inhaltstyp
application/json
Antwortinhaltstyp
application/json

Anforderungsparameter

  • space
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums. Er kann nur aus Buchstaben oder Zahlen bestehen und die Länge beträgt 4 bis 15 Zeichen.

Anforderungsdemo

{
    "space": "stardots"
    }

Antwortfelder

Keine Felder

Antwortdemo

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

Zugänglichkeit des Raums

Schalten Sie die Zugänglichkeit eines Raums um.

Anforderungsmethode
POST
Anforderungs-Pfad
/openapi/space/accessibility/toggle
Anforderung Inhaltstyp
application/json
Antwortinhaltstyp
application/json

Anforderungsparameter

  • space
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums. Er kann nur aus Buchstaben oder Zahlen bestehen und die Länge beträgt 4 bis 15 Zeichen.
  • public
    Daten Typ
    boolean
    Erforderlich
    Nein
    Beschreibung
    Gibt an, ob der Raum öffentlich zugänglich ist. Der Standardwert ist false.

Anforderungsdemo

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

Antwortfelder

Keine Felder

Antwortdemo

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

Dateiliste im Raum

Holen Sie sich die Liste der Dateien im Raum. Die Liste ist in absteigender Reihenfolge nach dem Dateiupload-Zeitpunkt sortiert.

Anforderungsmethode
GET
Anforderungs-Pfad
/openapi/file/list
Anforderung Inhaltstyp
application/json
Antwortinhaltstyp
application/json

Anforderungsparameter

  • space
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums. Er kann nur aus Buchstaben oder Zahlen bestehen und die Länge beträgt 4 bis 15 Zeichen.
  • page
    Daten Typ
    number
    Erforderlich
    Nein
    Beschreibung
    Seitenzahl, Standardwert ist 1.
  • pageSize
    Daten Typ
    number
    Erforderlich
    Nein
    Beschreibung
    Die Anzahl der Einträge pro Seite reicht von 1 bis 100, und der Standardwert ist 20.

Anforderungsdemo

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

Antwortfelder

  • page
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Seitenzahl, Standardwert ist 1.
  • pageSize
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Die Anzahl der Einträge pro Seite reicht von 1 bis 100, und der Standardwert ist 20.
  • totalCount
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Die Gesamtzahl der Einträge.
  • list
    Daten Typ
    array<object>
    Erforderlich
    Ja
    Beschreibung
    Dateiliste.
  • list.name
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name der Datei.
  • list.byteSize
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Die Größe der Datei in Bytes.
  • list.size
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Dateigröße, formatiert zur besseren Lesbarkeit.
  • list.uploadedAt
    Daten Typ
    number
    Erforderlich
    Ja
    Beschreibung
    Der Zeitstempel des Dateiuploads in Sekunden. Die Zeitzone ist UTC+8.
  • list.url
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Die Zugriffsadresse der Datei. Beachten Sie, dass wenn die Zugänglichkeit des Raums privat ist, dieser Wert das Zugriffsticket enthält, das für 20 Sekunden gültig ist.

Antwortdemo

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

Dateizugriffsticket

Holen Sie sich das Zugriffsticket für die Datei. Wenn die Zugänglichkeit des Raums privat ist, müssen Sie das Zugriffsticket mitbringen, um auf die Dateien im Raum zuzugreifen, andernfalls wird die Anfrage abgelehnt.

Anforderungsmethode
POST
Anforderungs-Pfad
/openapi/file/ticket
Anforderung Inhaltstyp
application/json
Antwortinhaltstyp
application/json

Anforderungsparameter

  • space
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums. Er kann nur eine Kombination aus Buchstaben oder Zahlen sein, und die Länge beträgt 4 bis 15 Zeichen.
  • filename
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name der Datei.

Anforderungsdemo

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

Antwortfelder

  • ticket
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Zugriffsticket.

Antwortdemo

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

Datei-Upload

Laden Sie die Datei in den Raum hoch. Beachten Sie, dass diese Anfrage erfordert, dass Sie die Anfrage in Form eines Formulars initiieren.

Anforderungsmethode
PUT
Anforderungs-Pfad
/openapi/file/upload
Anforderung Inhaltstyp
multipart/form-data
Antwortinhaltstyp
application/json

Anforderungsparameter

  • space
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums. Er kann nur eine Kombination aus Buchstaben oder Zahlen sein, und die Länge beträgt 4 bis 15 Zeichen.
  • file
    Daten Typ
    binary
    Erforderlich
    Ja
    Beschreibung
    Der Binärstrom der Datei. Beachten Sie, dass der Dateiname 170 Zeichen nicht überschreiten darf. Die Dateigröße darf 10 MB nicht überschreiten.

Antwortfelder

  • space
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums. Er kann nur eine Kombination aus Buchstaben oder Zahlen sein, und die Länge beträgt 4 bis 15 Zeichen.
  • filename
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name der Datei.
  • url
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Zugriff-Link der Datei. Wenn die Zugänglichkeit des Raums privat ist, wird der Zugriff-Link das Zugriffsticket enthalten.

Antwortdemo

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

Dateien löschen

Löschen Sie Dateien im Raum. Diese Schnittstelle unterstützt Batch-Operationen.

Anforderungsmethode
DELETE
Anforderungs-Pfad
/openapi/file/delete
Anforderung Inhaltstyp
application/json
Antwortinhaltstyp
application/json

Anforderungsparameter

  • space
    Daten Typ
    string
    Erforderlich
    Ja
    Beschreibung
    Der Name des Raums. Er kann nur eine Kombination aus Buchstaben oder Zahlen sein, und die Länge beträgt 4 bis 15 Zeichen.
  • filenameList
    Daten Typ
    array<string>
    Erforderlich
    Ja
    Beschreibung
    Array von Dateinamen.

Anforderungsdemo

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

Antwortfelder

Keine Felder

Antwortdemo

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

Server-Antwortcodes

Server-Antwortcodes sind Antwortcodes, die der Server an den Client zurückgibt, um das Ergebnis der Verarbeitung einer Anfrage darzustellen.

  • 200
    Beschreibung
    Erfolg
  • 504
    Beschreibung
    Anfrage überschritt das Zeitlimit
  • 999999
    Beschreibung
    Server-interner Fehler
  • 100000
    Beschreibung
    Anfrageparameterfehler
  • 100001
    Beschreibung
    Zugriffsticket abgelaufen
  • 100002
    Beschreibung
    Personen-Maschine-Überprüfung nicht bestanden
  • 100003
    Beschreibung
    Überprüfungscodes nicht korrekt
  • 100004
    Beschreibung
    Konto nicht vorhanden
  • 100005
    Beschreibung
    Passwort des Kontos stimmt nicht überein
  • 100006
    Beschreibung
    Abonnementplan nicht vorhanden
  • 100007
    Beschreibung
    SMS/E-Mail-Sendungen zu häufig
  • 100008
    Beschreibung
    SMS/E-Mail-Sendungen zu häufig
  • 100009
    Beschreibung
    Raum/Speicher nicht vorhanden
  • 100010
    Beschreibung
    Raum/Speicher bereits vorhanden
  • 100011
    Beschreibung
    Raum/Speicher nicht leer
  • 100012
    Beschreibung
    Operationen zu häufig
  • 100013
    Beschreibung
    Raum/Speicher-Anzahl-Kontingent erreicht
  • 100014
    Beschreibung
    Dateinummer-Kontingent erreicht
  • 100015
    Beschreibung
    Datenübertragungskontingent erschöpft
  • 100016
    Beschreibung
    Abonnementplan nicht übereinstimmt
  • 100017
    Beschreibung
    Raum/Speicher-Dateizugriff eingeschränkt
  • 100018
    Beschreibung
    Datei überschreitet die Größenbeschränkung
  • 100019
    Beschreibung
    Dateiformat nicht unterstützt
  • 100020
    Beschreibung
    Referer nicht erlaubt
  • 100021
    Beschreibung
    Funktionen nur für Pro- oder Premium-Benutzer verfügbar
  • 100022
    Beschreibung
    Funktionen nur für Premium-Benutzer verfügbar
  • 100023
    Beschreibung
    Zertifikatinhalt ungültig
  • 100024
    Beschreibung
    Zertifikat und privater Schlüssel stimmen nicht überein
  • 100025
    Beschreibung
    Ungültiger Bild-MIME-Typ
  • 100026
    Beschreibung
    Dateizugriffslink abgelaufen
  • 100027
    Beschreibung
    API-Aufrufe erreichten die Obergrenze
  • 100028
    Beschreibung
    Batch-Operationen nur für bezahlte Benutzer verfügbar
  • 100029
    Beschreibung
    Bildlink ungültig
  • 100030
    Beschreibung
    Konto wird als potenziell verstörend eingestuft und ist deaktiviert

SDK

StarDots stellt SDKs für verschiedene Programmiersprachen bereit, um Ihnen bei der schnellen Integration mit unserer API zu helfen. Sie finden die SDKs unter den folgenden Links:

Wenn Sie auf Probleme stoßen, kontaktieren Sie uns bitte