Proje API'si
mindzieStudio kiracılarında projeleri yönetin. Projeler, veri setleri, araştırmalar, panolar ve analiz iş akışları için en üst düzey kapsayıcılardır.
Özellikler
Proje Yönetimi
Projeler oluşturun, alın, güncelleyin ve silin. Bir kiracı içindeki tüm projeleri sayfalama desteği ile listeleyin.
Önbellek İşlemleri
Projeleri API işlemleri sırasında hızlı erişim için belleğe yükleyin. Not defterlerini ve blokları verimli çalıştırmak için gereklidir.
Kullanıcı İzinleri
Projeye kullanıcı erişimini yönetin. Kullanıcı ekleyin, izin seviyelerini (sahip veya üye) güncelleyin ve erişimi kaldırın.
Kullanıcılar API'sini Görüntüle
İçe Aktar & Dışa Aktar
Projeleri yedekleme veya transfer için taşınabilir .mpz dosyaları olarak dışa aktarın. .mpz dosyalarından projeleri içe aktarın. Proje küçük resimlerini yönetin.
İçe Aktar & Dışa Aktar API'sini Görüntüle
Mevcut Uç Noktalar
Bağlantı Testi
| Yöntem | Uç Nokta | Açıklama |
|---|---|---|
| GET | /api/{tenantId}/project/unauthorized-ping |
Genel bağlantı testi |
| GET | /api/{tenantId}/project/ping |
Yetkili bağlantı testi |
Proje CRUD
| Yöntem | Uç Nokta | Açıklama |
|---|---|---|
| GET | /api/{tenantId}/project |
Tüm projeleri listele |
| GET | /api/{tenantId}/project/{projectId} |
Proje detaylarını al |
| POST | /api/{tenantId}/project |
Proje oluştur |
| PUT | /api/{tenantId}/project/{projectId} |
Projeyi güncelle |
| DELETE | /api/{tenantId}/project/{projectId} |
Projeyi sil |
| GET | /api/{tenantId}/project/{projectId}/summary |
Proje istatistiklerini al |
Önbellek Yönetimi
| Yöntem | Uç Nokta | Açıklama |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/load |
Projeyi önbelleğe yükle |
| DELETE | /api/{tenantId}/project/{projectId}/unload |
Projeyi önbellekten boşalt |
Kullanıcı İzinleri
| Yöntem | Uç Nokta | Açıklama |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/users |
Proje kullanıcılarını listele |
| POST | /api/{tenantId}/project/{projectId}/users/{userId} |
Kullanıcıyı projeye ekle |
| PUT | /api/{tenantId}/project/{projectId}/users/{userId} |
Kullanıcı iznini güncelle |
| DELETE | /api/{tenantId}/project/{projectId}/users/{userId} |
Kullanıcıyı kaldır |
İçe/Dışa Aktar
| Yöntem | Uç Nokta | Açıklama |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/download |
.mpz olarak dışa aktar |
| POST | /api/{tenantId}/project/import |
.mpz'den içe aktar |
Küçük Resimler
| Yöntem | Uç Nokta | Açıklama |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/thumbnail |
Küçük resmi al |
| POST | /api/{tenantId}/project/{projectId}/thumbnail |
Küçük resmi güncelle |
| DELETE | /api/{tenantId}/project/{projectId}/thumbnail |
Küçük resmi kaldır |
Kimlik Doğrulama
Tüm Proje API uç noktaları geçerli bir API anahtarı gerektirir. Proje işlemleri için kiracı kapsamlı API anahtarlarını kullanın.
API anahtarı türleri ve kullanımı için Kimlik Doğrulama sayfasına bakın.
Hızlı Başlangıç
# Bir kiracıdaki tüm projeleri listele
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project" \
-H "Authorization: Bearer YOUR_API_KEY"
# Not defterlerini çalıştırmadan önce projeyi önbelleğe yükle
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project/{projectId}/load" \
-H "Authorization: Bearer YOUR_API_KEY"
Önemli Notlar
- YAYILIMLI Silme: Bir proje silindiğinde tüm veri setleri, araştırmalar, panolar ve dosyalar kalıcı olarak silinir
- Önbellek Gereklidir: Not defterlerini veya blokları çalıştırmadan önce projeleri önbelleğe yükleyin
- Önbellek Süresi: Projeler son erişimden sonra 30 dakika boyunca önbellekte kalır
- Silmeden Önce Dışa Aktarın: Projeleri silmeden önce her zaman yedek olarak dışa aktarın