StarDots.io Logo

StarDots

Laman utama dokumentasi

Open API

Bab ini akan memperkenalkan cara untuk mengintegrasikan API terbuka. Pengetahuan berikut adalah untuk pembangun, dan kami menganggap bahawa anda mempunyai asas pengaturcaraan yang tertentu.

Adakah anda ejen AI? Baca dokumentasi Markdown
Pada halaman ini

Pengesahan

StarDots melakukan pengesahan dengan membaca medan header dalam permintaan http yang dimulakan oleh klien dan mengesahkan medan yang relevan. Oleh itu, semua permintaan API terbuka harus membawa maklumat medan pengesahan ini, dan anda perlu mencatat bahawa medan ini peka huruf dan semua medan mestilah dalam huruf kecil.

  • x-stardots-timestamp
    Penerangan
    Timestamp semasa dalam saat. Perbezaan dengan pelayan StarDots tidak boleh melebihi 60 saat. Nota: Zon masa StarDots adalah Asia/Singapore, yang UTC+8.
  • x-stardots-nonce
    Penerangan
    Rentetan rawak 4 hingga 20 aksara, yang hanya boleh mengandungi huruf besar, huruf kecil, dan nombor. Nota bahawa nilai ini mesti unik dalam 60 saat.
  • x-stardots-key
    Penerangan
    Maklumat kunci yang dikeluarkan oleh StarDots.
  • x-stardots-sign
    Penerangan
    Medan tandatangan adalah rentetan yang dihasilkan dengan menggabungkan medan di atas mengikut algoritma tandatangan tertentu. Algoritma tandatangan khusus akan diperkenalkan seterusnya.

Algoritma Tandatangan

Kami menganggap nilai medan berikut

key
2dcded8e-f231-4d0a-8498-d10ef0639eb3
secret
Ey1JNRCiJOzaIOIilcyJvteTn5YXykFXUwmiHLymK8LHkITfGPo5mTUdLlg0jPHST9fMwMZKxIKUBvSsT5uxrq0lXuerll3eRW2tbMOsvySRY539L8cR6iRFV2DQqdlzbseyq7k9N0U5pZgj6f43e3MngbIttgSDl1G44IBOwqsI2HVXE5H6mf1bHlvWw6Ziuk8Xcw18AioG47SFBLIatrq6E9yEBJgFgcYysCH8JvY659hhqI3Ii1CA5zVtyNp
x-stardots-timestamp
1728958751
x-stardots-nonce
fQvDmMLnKE
x-stardots-key
2dcded8e-f231-4d0a-8498-d10ef0639eb3
Kunci dan Rahsia dikeluarkan oleh StarDots, anda boleh menemuinya di halaman tetapan konsol.

Kemudian kami menggabungkan nilai medan di atas

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

Seterusnya, kami mengira hash MD5 bagi rentetan yang digabungkan di atas

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

Akhirnya, kami menukar rentetan ringkasan kepada huruf besar

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

Oleh itu, nilai akhir bagi medan x-stardots-sign adalah 51DABFE4B47E73D4A3B85FE29C4F1E82

Badan respons HTTP umum

Semua respons antaramuka mengekalkan struktur data yang seragam

  • code
    Jenis data
    nombor
    Diperlukan
    Ya
    Penerangan
    Kod respons perkhidmatan. 200 menunjukkan kejayaan.
  • message
    Jenis data
    rentetan
    Diperlukan
    Ya
    Penerangan
    Mesej arahan bagi hasil operasi.
  • requestId
    Jenis data
    rentetan
    Diperlukan
    Ya
    Penerangan
    Nombor unik untuk permintaan, yang boleh digunakan untuk menyelesaikan masalah.
  • success
    Jenis data
    boolean
    Diperlukan
    Ya
    Penerangan
    Menunjukkan sama ada operasi perniagaan berjaya.
  • ts
    Jenis data
    nombor
    Diperlukan
    Ya
    Penerangan
    Timestamp dalam milisaat daripada pelayan.
  • data
    Jenis data
    apa sahaja
    Diperlukan
    Ya
    Penerangan
    Medan data perniagaan. Medan ini boleh mempunyai sebarang jenis data. Untuk jenis data tertentu, sila rujuk antaramuka yang berkaitan.

Antaramuka Fungsional

Perhatikan bahawa semua antaramuka akan mempunyai had kadar permintaan, dan semua antaramuka berkongsi satu set peraturan had kadar. Setakat ini, had kadar StarDots adalah 300 kali per minit.

Titik akhir permintaan

https://api.stardots.io

Senarai Ruang

Dapatkan data senarai ruang.

Kaedah permintaan
GET
Jalan permintaan
/openapi/space/list
Jenis kandungan permintaan
application/json
Jenis kandungan respons
application/json

Parameter permintaan

  • page
    Jenis data
    nombor
    Diperlukan
    Tidak
    Penerangan
    Nombor halaman, nilai lalai adalah 1.
  • pageSize
    Jenis data
    nombor
    Diperlukan
    Tidak
    Penerangan
    Bilangan entri bagi setiap halaman yang boleh dipilih antara 1 hingga 100, dan nilai lalai adalah 20.

Demo permintaan

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

Medan respons

  • name
    Jenis data
    rentetan
    Diperlukan
    Ya
    Penerangan
    Nama ruang.
  • public
    Jenis data
    boolean
    Diperlukan
    Ya
    Penerangan
    Menunjukkan sama ada akses ruang adalah salah.
  • createdAt
    Jenis data
    nombor
    Diperlukan
    Ya
    Penerangan
    Timestamp sistem dalam saat apabila ruang dicipta. Zon waktu adalah UTC+8.
  • fileCount
    Jenis data
    nombor
    Diperlukan
    Ya
    Penerangan
    Bilangan fail dalam ruang ini.

Demo respons

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

Cipta Ruang

Cipta ruang baru.

Kaedah permintaan
PUT
Jalan permintaan
/openapi/space/create
Jenis kandungan permintaan
application/json
Jenis kandungan respons
application/json

Parameter permintaan

  • space
    Jenis data
    rentetan
    Diperlukan
    Ya
    Penerangan
    Nama ruang. Ia hanya boleh menjadi gabungan huruf atau nombor, dan panjangnya adalah antara 4 hingga 15 aksara.
  • public
    Jenis data
    boolean
    Diperlukan
    Tidak
    Penerangan
    Menentukan sama ada ruang boleh diakses secara awam. Nilai lalai adalah salah.

Demo permintaan

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

Medan respons

Tiada medan

Demo respons

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

Padam Ruang

Padam ruang yang sedia ada. Sila pastikan bahawa tiada fail dalam ruang ini, jika tidak, pemadaman akan gagal.

Kaedah permintaan
DELETE
Jalan permintaan
/openapi/space/delete
Jenis kandungan permintaan
application/json
Jenis kandungan respons
application/json

Parameter permintaan

  • space
    Jenis data
    rentetan
    Diperlukan
    Ya
    Penerangan
    Nama ruang. Ia hanya boleh menjadi gabungan huruf atau nombor, dan panjangnya adalah antara 4 hingga 15 aksara.

Demo permintaan

{
    "space": "stardots"
    }

Medan respons

Tiada medan

Demo respons

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

Aksesibiliti Ruang

Tukar aksesibiliti ruang.

Kaedah permintaan
POST
Jalan permintaan
/openapi/space/accessibility/toggle
Jenis kandungan permintaan
application/json
Jenis kandungan respons
application/json

Parameter permintaan

  • space
    Jenis data
    rentetan
    Diperlukan
    Ya
    Penerangan
    Nama ruang. Ia hanya boleh menjadi gabungan huruf atau nombor, dan panjangnya adalah antara 4 hingga 15 aksara.
  • public
    Jenis data
    boolean
    Diperlukan
    Tidak
    Penerangan
    Menentukan sama ada ruang ini boleh diakses secara awam. Nilai lalai adalah false.

Demo permintaan

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

Medan respons

Tiada medan

Demo respons

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

Senarai Fail dalam Ruang

Dapatkan senarai fail dalam ruang. Senarai ini disusun dalam susunan menurun berdasarkan masa muat naik fail.

Kaedah permintaan
GET
Jalan permintaan
/openapi/file/list
Jenis kandungan permintaan
application/json
Jenis kandungan respons
application/json

Parameter permintaan

  • space
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Nama ruang. Ia hanya boleh menjadi gabungan huruf atau nombor, dan panjangnya adalah antara 4 hingga 15 aksara.
  • page
    Jenis data
    number
    Diperlukan
    Tidak
    Penerangan
    Nombor halaman, nilai lalai adalah 1.
  • pageSize
    Jenis data
    number
    Diperlukan
    Tidak
    Penerangan
    Bilangan entri setiap halaman adalah antara 1 hingga 100, dan nilai lalai adalah 20.

Demo permintaan

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

Medan respons

  • page
    Jenis data
    number
    Diperlukan
    Ya
    Penerangan
    Nombor halaman, nilai lalai adalah 1.
  • pageSize
    Jenis data
    number
    Diperlukan
    Ya
    Penerangan
    Bilangan entri setiap halaman adalah antara 1 hingga 100, dan nilai lalai adalah 20.
  • totalCount
    Jenis data
    number
    Diperlukan
    Ya
    Penerangan
    Jumlah entri.
  • list
    Jenis data
    array<object>
    Diperlukan
    Ya
    Penerangan
    Senarai fail dalam bentuk array.
  • list.name
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Nama fail.
  • list.byteSize
    Jenis data
    number
    Diperlukan
    Ya
    Penerangan
    Saiz fail dalam bait.
  • list.size
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Saiz fail, diformat untuk kemudahan pembacaan.
  • list.uploadedAt
    Jenis data
    number
    Diperlukan
    Ya
    Penerangan
    Timestamp muat naik fail dalam saat. Zon masa adalah UTC+8.
  • list.url
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Alamat akses fail. Perhatikan bahawa jika aksesibiliti ruang adalah peribadi, nilai medan ini akan membawa tiket akses, yang sah selama 20 saat.

Demo respons

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

Tiket Akses Fail

Dapatkan tiket akses untuk fail. Apabila aksesibiliti ruang adalah peribadi, anda perlu membawa tiket akses untuk mengakses fail dalam ruang tersebut, jika tidak permintaan akan ditolak.

Kaedah permintaan
POST
Jalan permintaan
/openapi/file/ticket
Jenis kandungan permintaan
application/json
Jenis kandungan respons
application/json

Parameter permintaan

  • space
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Nama ruang. Ia hanya boleh menjadi gabungan huruf atau nombor, dan panjangnya adalah antara 4 hingga 15 aksara.
  • filename
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Nama fail.

Demo permintaan

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

Medan respons

  • ticket
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Tiket Akses.

Demo respons

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

Muat Naik Fail

Muat naik fail ke ruang tersebut. Perhatikan bahawa permintaan ini memerlukan anda untuk memulakan permintaan dalam bentuk borang.

Kaedah permintaan
PUT
Jalan permintaan
/openapi/file/upload
Jenis kandungan permintaan
multipart/form-data
Jenis kandungan respons
application/json

Parameter permintaan

  • space
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Nama ruang. Ia hanya boleh menjadi gabungan huruf atau nombor, dan panjangnya adalah antara 4 hingga 15 aksara.
  • file
    Jenis data
    binary
    Diperlukan
    Ya
    Penerangan
    Aliran binari fail. Perhatikan bahawa nama fail tidak boleh melebihi 170 aksara. Saiz fail tidak boleh melebihi 10MB.

Medan respons

  • space
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Nama ruang. Ia hanya boleh menjadi gabungan huruf atau nombor, dan panjangnya adalah antara 4 hingga 15 aksara.
  • filename
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Nama fail.
  • url
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Pautan akses fail. Jika aksesibiliti ruang adalah peribadi, pautan akses akan membawa tiket akses.

Demo respons

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

Padam Fail

Padam fail dalam ruang tersebut. Antara muka ini menyokong operasi kumpulan.

Kaedah permintaan
DELETE
Jalan permintaan
/openapi/file/delete
Jenis kandungan permintaan
application/json
Jenis kandungan respons
application/json

Parameter permintaan

  • space
    Jenis data
    string
    Diperlukan
    Ya
    Penerangan
    Nama ruang. Ia hanya boleh menjadi gabungan huruf atau nombor, dan panjangnya adalah antara 4 hingga 15 aksara.
  • filenameList
    Jenis data
    array<string>
    Diperlukan
    Ya
    Penerangan
    Array nama fail.

Demo permintaan

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

Medan respons

Tiada medan

Demo respons

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

Kod Respons Pelayan

Kod respons pelayan adalah kod respons yang dikembalikan oleh pelayan kepada pelanggan untuk mewakili hasil pemprosesan permintaan.

  • 200
    Perihal
    Berjaya
  • 504
    Perihal
    Permintaan melebihi masa
  • 999999
    Perihal
    Ralat dalaman pelayan
  • 100000
    Perihal
    Parameter permintaan tidak betul
  • 100001
    Perihal
    Tiket akses tidak sah
  • 100002
    Perihal
    Pengesahan manusia tidak berjaya
  • 100003
    Perihal
    Kod pengesahan tidak betul
  • 100004
    Perihal
    Akun tidak wujud
  • 100005
    Perihal
    Kata laluan akun tidak sesuai
  • 100006
    Perihal
    Langganan tidak wujud
  • 100007
    Perihal
    Pengiriman SMS/email terlalu sering
  • 100008
    Perihal
    Pengiriman SMS/email melebihi had
  • 100009
    Perihal
    Ruang/Storage tidak wujud
  • 100010
    Perihal
    Ruang/Storage sudah wujud
  • 100011
    Perihal
    Ruang/Storage tidak kosong
  • 100012
    Perihal
    Operasi terlalu sering
  • 100013
    Perihal
    Ruang/Storage bilangan kuota telah mencapai had
  • 100014
    Perihal
    Bilangan kuota fail telah mencapai had
  • 100015
    Perihal
    Kuota pengiriman data telah habis
  • 100016
    Perihal
    Langganan tidak sesuai
  • 100017
    Perihal
    Ruang/Storage fail akses dibatasi
  • 100018
    Perihal
    Fail melebihi had saiz
  • 100019
    Perihal
    Format fail tidak disokong
  • 100020
    Perihal
    Referer tidak dibenarkan
  • 100021
    Perihal
    Fungsi hanya untuk Pro atau Premium pengguna
  • 100022
    Perihal
    Fungsi hanya untuk Premium pengguna
  • 100023
    Perihal
    Kandungan sertifikat tidak sah
  • 100024
    Perihal
    Sertifikat dan kunci pribadi tidak sesuai
  • 100025
    Perihal
    Jenis MIME gambar tidak sah
  • 100026
    Perihal
    Pautan akses fail telah tamat
  • 100027
    Perihal
    Jumlah panggilan API telah mencapai had
  • 100028
    Perihal
    Operasi batch hanya untuk pengguna berbayar
  • 100029
    Perihal
    Pautan gambar tidak sah
  • 100030
    Perihal
    Akun dipercayai melanggar peraturan, dan telah dilarang untuk login

SDK

StarDots menyediakan SDK untuk pelbagai bahasa pengaturcaraan untuk membantu anda mengintegrasikan dengan API kami dengan cepat. Anda boleh mencari SDK di pautan berikut:

Jika anda menghadapi sebarang masalah, sila hubungi kami