StarDots.io Logo

StarDots

Dokümantasyon ana sayfası

Açık API

Bu bölüm, açık API'lerin nasıl entegre edileceğini tanıtacaktır. Aşağıdaki bilgiler geliştiriciler içindir ve belirli bir programlama temelinizin olduğunu varsayıyoruz.

Yapay zekâ ajanı mısınız? Markdown belgelerini okuyun
Bu sayfada

Kimlik Doğrulama

StarDots, istemci tarafından başlatılan http isteğindeki başlık alanını okuyarak ve ilgili alanları doğrulayarak kimlik doğrulama işlemi yapar. Bu nedenle, tüm açık API istekleri bu kimlik doğrulama alanı bilgilerini taşımalıdır ve bu alanların büyük/küçük harfe duyarlı olduğunu ve tüm alanların küçük harflerle yazılması gerektiğini unutmamalısınız.

  • x-stardots-timestamp
    Açıklama
    Geçerli zaman damgası saniye cinsinden. StarDots sunucusuyla fark 60 saniyeyi geçemez. Not: StarDots'un zaman dilimi Asia/Singapore'dur, yani UTC+8'dir.
  • x-stardots-nonce
    Açıklama
    4 ila 20 karakter uzunluğunda rastgele bir dize, yalnızca büyük harfler, küçük harfler ve sayılar içerebilir. Bu değerin 60 saniye içinde benzersiz olması gerektiğini unutmayın.
  • x-stardots-key
    Açıklama
    StarDots tarafından verilen anahtar bilgisi.
  • x-stardots-sign
    Açıklama
    İmza alanı, yukarıdaki alanları belirli bir imza algoritmasına göre birleştirerek oluşturulan bir dizgedir. Spesifik imza algoritması bir sonraki bölümde tanıtılacaktır.

İmza algoritması

Aşağıdaki alan değerlerini varsayıyoruz

key
2dcded8e-f231-4d0a-8498-d10ef0639eb3
secret
Ey1JNRCiJOzaIOIilcyJvteTn5YXykFXUwmiHLymK8LHkITfGPo5mTUdLlg0jPHST9fMwMZKxIKUBvSsT5uxrq0lXuerll3eRW2tbMOsvySRY539L8cR6iRFV2DQqdlzbseyq7k9N0U5pZgj6f43e3MngbIttgSDl1G44IBOwqsI2HVXE5H6mf1bHlvWw6Ziuk8Xcw18AioG47SFBLIatrq6E9yEBJgFgcYysCH8JvY659hhqI3Ii1CA5zVtyNp
x-stardots-timestamp
1728958751
x-stardots-nonce
fQvDmMLnKE
x-stardots-key
2dcded8e-f231-4d0a-8498-d10ef0639eb3
Anahtar ve Gizli anahtar StarDots tarafından verilmiştir, bunları konsol ayarları sayfasında bulabilirsiniz.

Sonra, yukarıdaki alan değerlerini birleştiriyoruz

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

Sonra, yukarıda birleştirilen dizgenin MD5 özeti hesaplanır

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

Son olarak, özet dizgesini büyük harfe çeviriyoruz

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

Bu nedenle, x-stardots-sign alanının son değeri 51DABFE4B47E73D4A3B85FE29C4F1E82

Ortak HTTP yanıt gövdesi

Tüm arayüz yanıtları birleşik bir veri yapısını korur

  • code
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Hizmet yanıt kodu. 200 başarıyı gösterir.
  • message
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    İşlem sonucu mesajı.
  • requestId
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    İstek için benzersiz bir numara, bu numara sorun giderme için kullanılabilir.
  • success
    Veri türü
    boolean
    Gerekli
    Evet
    Açıklama
    İşlem operasyonunun başarılı olup olmadığını gösterir.
  • ts
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Sunucu milisaniye zaman damgası.
  • data
    Veri türü
    any
    Gerekli
    Evet
    Açıklama
    İş verisi alanı. Bu alan her türlü veri türüne sahip olabilir. Belirli veri türleri için lütfen ilgili arayüze bakın.

Fonksiyonel Arayüz

Tüm arayüzlerin istek oranı sınırları olduğunu unutmayın ve tüm arayüzler bir dizi oran sınırı kuralını paylaşır. Şu ana kadar, StarDots'un oran sınırı dakikada 300 istekle sınırlıdır.

İstek uç noktası

https://api.stardots.io

Alan Listesi

Alan listesi verilerini alın.

İstek yöntemi
GET
İstek yolu
/openapi/space/list
İstek içerik tipi
application/json
Yanıt içerik tipi
application/json

İstek parametreleri

  • page
    Veri türü
    number
    Gerekli
    Hayır
    Açıklama
    Sayfa numarası, varsayılan değer 1'dir.
  • pageSize
    Veri türü
    number
    Gerekli
    Hayır
    Açıklama
    Sayfa başına girilen sayı 1 ile 100 arasında değişir ve varsayılan değer 20'dir.

İstek örneği

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

Yanıt alanları

  • name
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı.
  • public
    Veri türü
    boolean
    Gerekli
    Evet
    Açıklama
    Alan erişilebilirliğinin yanlış olup olmadığı.
  • createdAt
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Alan oluşturulduğunda sistem zaman damgası (saniye cinsinden). Zaman dilimi UTC+8'dir.
  • fileCount
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Bu alandaki dosya sayısı.

Yanıt örneği

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

Alan Oluştur

Yeni bir alan oluştur.

İstek yöntemi
PUT
İstek yolu
/openapi/space/create
İstek içerik tipi
application/json
Yanıt içerik türü
application/json

İstek parametreleri

  • space
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı. Sadece harf ve rakamlardan oluşabilir, uzunluğu 4 ile 15 karakter arasında olmalıdır.
  • public
    Veri türü
    boolean
    Gerekli
    Hayır
    Açıklama
    Alanının halka açık olup olmadığını belirtir. Varsayılan değer 'false' (yanlış) dır.

İstek örneği

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

Yanıt alanları

Alan yok

Yanıt demo

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

Alan Sil

Mevcut bir alanı silin. Bu alanda dosya olmadığından emin olmanız gerektiğini unutmayın, aksi takdirde silme işlemi başarısız olur.

İstek yöntemi
DELETE
İstek yolu
/openapi/space/delete
İstek içerik tipi
application/json
Yanıt içerik türü
application/json

İstek parametreleri

  • space
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı. Sadece harf ve rakamlardan oluşabilir, uzunluğu 4 ile 15 karakter arasında olmalıdır.

İstek örneği

{
    "space": "stardots"
    }

Yanıt alanları

Alan yok

Yanıt demo

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

Alan Erişilebilirliği

Bir alanın erişilebilirliğini değiştirin.

İstek yöntemi
POST
İstek yolu
/openapi/space/accessibility/toggle
İstek içerik tipi
application/json
Yanıt içerik türü
application/json

İstek parametreleri

  • space
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı. Sadece harf ve rakamlardan oluşabilir, uzunluğu 4 ile 15 karakter arasında olmalıdır.
  • public
    Veri türü
    boolean
    Gerekli
    Hayır
    Açıklama
    Alanının herkese açık olup olmadığını belirtir. Varsayılan değer yanlış (false) dır.

İstek örneği

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

Yanıt alanları

Alan yok

Yanıt demo

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

Alan İçindeki Dosya Listesi

Alan içindeki dosyaların listesini alın. Liste, dosya yükleme zamanına göre azalan sırayla sıralanır.

İstek yöntemi
GET
İstek yolu
/openapi/file/list
İstek içerik tipi
application/json
Yanıt içerik türü
application/json

İstek parametreleri

  • space
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı. Sadece harfler veya rakamların birleşimi olabilir ve uzunluğu 4 ila 15 karakter arasında olmalıdır.
  • page
    Veri türü
    number
    Gerekli
    Hayır
    Açıklama
    Sayfa numarası, varsayılan değer 1'dir.
  • pageSize
    Veri türü
    number
    Gerekli
    Hayır
    Açıklama
    Sayfa başına giriş sayısı 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.

İstek örneği

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

Yanıt alanları

  • page
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Sayfa numarası, varsayılan değer 1'dir.
  • pageSize
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Sayfa başına giriş sayısı 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
  • totalCount
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Toplam giriş sayısı.
  • list
    Veri türü
    array<object>
    Gerekli
    Evet
    Açıklama
    Dosya listesi dizisi.
  • list.name
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Dosyanın adı.
  • list.byteSize
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Dosyanın byte cinsinden boyutu.
  • list.size
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Dosya boyutu, okunabilirlik için biçimlendirilmiş.
  • list.uploadedAt
    Veri türü
    number
    Gerekli
    Evet
    Açıklama
    Dosya yüklemesinin saniye cinsinden zaman damgası. Zaman dilimi UTC+8'dir.
  • list.url
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Dosyanın erişim adresi. Alanın erişilebilirliği özel ise, bu alanın değeri erişim biletini taşıyacak ve 20 saniye geçerliliği olacaktır.

Yanıt demo

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

Dosya Erişim Bileti

Dosya için erişim biletini alın. Alanın erişilebilirliği özel olduğunda, alandaki dosyalara erişim sağlamak için erişim biletini getirmeniz gerekir, aksi takdirde istek reddedilecektir.

İstek yöntemi
POST
İstek yolu
/openapi/file/ticket
İstek içerik tipi
application/json
Yanıt içerik türü
application/json

İstek parametreleri

  • space
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı. Sadece harfler veya rakamların birleşimi olabilir ve uzunluğu 4 ila 15 karakter arasında olmalıdır.
  • filename
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Dosyanın adı.

İstek örneği

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

Yanıt alanları

  • ticket
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Erişim Bileti.

Yanıt demo

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

Dosya Yükleme

Dosyayı alana yükleyin. Bu isteğin, isteği bir form şeklinde başlatmanız gerektiğini unutmayın.

İstek yöntemi
PUT
İstek yolu
/openapi/file/upload
İstek içerik tipi
multipart/form-data
Yanıt içerik türü
application/json

İstek parametreleri

  • space
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı. Sadece harfler veya rakamların birleşimi olabilir ve uzunluğu 4 ila 15 karakter arasında olmalıdır.
  • file
    Veri türü
    binary
    Gerekli
    Evet
    Açıklama
    Dosyanın ikili veri akışı. Dosya adı 170 karakteri geçmemelidir. Dosya boyutu 10MB'yi geçemez.

Yanıt alanları

  • space
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı. Sadece harfler veya rakamların birleşimi olabilir ve uzunluğu 4 ila 15 karakter arasında olmalıdır.
  • filename
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Dosyanın adı.
  • url
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Dosyanın erişim bağlantısı. Eğer alanın erişilebilirliği özelse, erişim bağlantısı erişim biletini taşıyacaktır.

Yanıt demo

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

Dosya Silme

Alandaki dosyaları silin. Bu arayüz, toplu işlemleri destekler.

İstek yöntemi
DELETE
İstek yolu
/openapi/file/delete
İstek içerik tipi
application/json
Yanıt içerik türü
application/json

İstek parametreleri

  • space
    Veri türü
    string
    Gerekli
    Evet
    Açıklama
    Alan adı. Sadece harfler veya rakamların birleşimi olabilir ve uzunluğu 4 ila 15 karakter arasında olmalıdır.
  • filenameList
    Veri türü
    array<string>
    Gerekli
    Evet
    Açıklama
    Dosya adlarının dizisi.

İstek örneği

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

Yanıt alanları

Alan yok

Yanıt demo

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

Sunucu Yanıt Kodları

Sunucu yanıt kodları, sunucunun isteği işleyen sonucunu temsil eden kodlardır. Sunucu, isteği işlediğinde, isteğin başarılı bir şekilde işlendiğini gösteren bir kod döndürür.

  • 200
    Açıklama
    Başarılı
  • 504
    Açıklama
    İstek zaman aşımına uğradı
  • 999999
    Açıklama
    Sunucu iç hatası
  • 100000
    Açıklama
    İstek parametre hatası
  • 100001
    Açıklama
    Erişim biletinin süresi doldu
  • 100002
    Açıklama
    Kişi-makine doğrulaması geçemedi
  • 100003
    Açıklama
    Doğrulama kodu yanlış
  • 100004
    Açıklama
    Hesap mevcut değil
  • 100005
    Açıklama
    Hesap şifresi eşleşmiyor
  • 100006
    Açıklama
    Plano de suscripción no existe
  • 100007
    Açıklama
    SMS/E-posta gönderimi çok sık
  • 100008
    Açıklama
    SMS/E-posta gönderimi çok sık
  • 100009
    Açıklama
    Alan/Depolama kabı bulunamadı
  • 100010
    Açıklama
    Alan/Depolama kabı mevcut
  • 100011
    Açıklama
    Alan/Depolama kabı boş değil
  • 100012
    Açıklama
    İşlem çok sık
  • 100013
    Açıklama
    Alan/Depolama kabı sayısı kotası doldu
  • 100014
    Açıklama
    Alan/Depolama kabı sayısı kotası doldu
  • 100015
    Açıklama
    Aktarım kotası doldu
  • 100016
    Açıklama
    Plano de suscripción no coincide
  • 100017
    Açıklama
    Alan/Depolama kabı dosya erişimi kısıtlı
  • 100018
    Açıklama
    Dosya boyutu sınırını aştı
  • 100019
    Açıklama
    Dosya formatı desteklenmiyor
  • 100020
    Açıklama
    Referer izni yok
  • 100021
    Açıklama
    İşlevler yalnızca Pro veya Premium kullanıcılar için açıktır
  • 100022
    Açıklama
    İşlevler yalnızca Premium kullanıcılar için açıktır
  • 100023
    Açıklama
    Sertifika içeriği geçersiz
  • 100024
    Açıklama
    Sertifika ve özel anahtar eşleşmiyor
  • 100025
    Açıklama
    Geçersiz görüntü MIME türü
  • 100026
    Açıklama
    Dosya erişim linki geçersiz
  • 100027
    Açıklama
    API çağrı sayısı sınırına ulaştı
  • 100028
    Açıklama
    Toplu işlemler yalnızca ödeme kullanıcılar için açıktır
  • 100029
    Açıklama
    Görüntü linki geçersiz
  • 100030
    Açıklama
    Hesap suçlu olarak kabul edildi, giriş engellendi

SDK

StarDots, API'miz ile hızlı entegrasyon sağlamanıza yardımcı olmak için çeşitli programlama dilleri için SDK'lar sağlar. SDK'ları aşağıdaki bağlantılarda bulabilirsiniz:

Herhangi bir sorunla karşılaşırsanız, lütfen bizimle iletişime geçin