Okullar, öğrencileri, personeli ve etkinlikleri yönetmek için giderek daha fazla sayıda sisteme güveniyor ve bu verilerin senkronize edilmesi geçmişte manuel yeniden giriş veya özel çözümler gerektiriyordu. SchoolsBuddy Genel API'si bunu değiştiriyor ve okullara SchoolsBuddy halihazırda kullandıkları araçlarla güvenli ve doğrudan bir şekilde bağlama olanağı sunuyor.

Temel kullanıcı ve etkinlik yönetimi etrafında inşa edilen API, geliştirme ekiplerine SchoolsBuddy ile programatik olarak etkileşim kurmak için ölçeklenebilir ve esnek bir yol sunar; her entegrasyonun güvenliğini sağlamak için erişim, Kuruluş Süper Yöneticileri tarafından sıkı bir şekilde kontrol edilir.

Genel Bakış

SchoolsBuddy Genel API'si, manuel veri girişini azaltmak ve okulunuzun ekosistemi genelinde verilerin senkronize kalmasını sağlamak için tasarlanmıştır. Genellikle, toplu yönetim görevlerini otomatikleştirmeye veya SchoolsBuddy özel veya kurum içi geliştirilmiş bir MIS/SIS platformuyla entegre etmeye ihtiyaç duyan teknik ekipler, yani Kurum Süper Yöneticileri ve geliştiricileri için geliştirilmiştir.

Ne var ne yok

API, Öğrenciler, Kişiler, Personel, Etkinlikler, Konumlar, Gruplar ve Tercih ve Anında Rezervasyon Kayıtları dahil olmak üzere temel veri varlıkları için uç noktalar içerir. Başlıca özellikler şunlardır:

• Konum Yönetimi: Tüm okul etkinliklerinde kullanılacak özel konumlar oluşturun ve yönetin.
• Veri Dışa Aktarma: Sorunsuz görüntüleme ve diğer dahili sistemlerle entegrasyon için SchoolsBuddy etkinliklerini öğrenci veya etkinlik bazında dışa aktarın.
• Devam Takip API'si: Okulunuzun tüm ekosistemini gerçek zamanlı olarak senkronize tutmak için etkinlik devam kayıtlarını programatik olarak okuyun ve yazın.
• Dışarıdan Öğrenci Kaydı: Okulun öğrenci bilgi sisteminde (SIS) kayıtlı olmayan öğrencileri (örneğin, ön kayıt yaptıranlar, yaz okulu katılımcıları veya dışarıdan zenginleştirme programlarına katılanlar) ekleyin ve yönetin.
• Personel ve Eğitmen Kayıtları: Konuk eğitmenler, harici koçlar, gezi liderleri veya bölge personeli de dahil olmak üzere, SIS'te bulunmayan harici personeli yönetin.
• Sanal Entegrasyon: Okulunuzun seçtiği dijital iletişim platformları için öğretmenlerin çevrimiçi toplantı kimliklerini güncelleyin ve yönetin.
• Oluşturma ve Yönetme: Tercih ve Anında Kayıt Grupları, Spor veya Gezi etkinlik planlaması için Gruplar, Ücret tahsilatı için Gruplar ve Veli Öğretmen görüşmeleri için Ders Grupları (yalnızca başka bir veri içe aktarma kaynağınız yoksa gereklidir).

Adım Adım Gezinme

API istemcinizi kurma

Yönetici Ayarları > Entegrasyonlar > Genel API

1. API erişimini sağlamak için bu role ihtiyaç duyulduğundan, lütfen Kuruluş Süper Yöneticisi olarak oturum açtığınızdan emin olun.
2. API istemcinizi kaydetmek ve kimlik bilgilerini oluşturmak için özel kurulum kılavuzunu takip edin.
3. Sağlanan kimlik bilgilerini kullanarak entegrasyonunuz için OAuth 2.0 kimlik doğrulamasını yapılandırın.
4. İlk çağrılarınızı oluşturmadan önce Swagger dokümanında bulunan uç noktaları (Öğrenciler, Kişiler, Personel, Etkinlikler, Konumlar, Gruplar, Kayıtlar) inceleyin.
5. Mümkünse, canlı veri senkronizasyonuna geçmeden önce entegrasyonunuzu üretim dışı bir veri kümesi üzerinde test edin.

Kurulumla ilgili tüm talimatlar burada mevcuttur: SchoolsBuddy Genel API'sini Nasıl Kurarsınız ?

İpuçları ve En İyi Uygulamalar

• Önce Güvenlik: Verilerinize güvenli erişim sağlamak için sunulan OAuth 2.0 kimlik doğrulama standardını kullanın.
• Dokümantasyonu İnceleyin: Geliştiriciler, uç nokta özelliklerinin ve kimlik doğrulama kılavuzunun tamamı için Entegrasyonlar Portalı'na ve Swagger sayfasına başvurmalıdır.
• Verimlilik: Büyük veri kümeleriyle çalışırken verimli veri erişimi için sayfalama meta verilerini kullanın.

Uyarılar ve Önemli Notlar

İlgili Makaleler

• SchoolsBuddy Genel API'si Nasıl Kurulur?
• Organizasyon Süper Yönetici İzinlerini Yönetme

Sıkça Sorulan Sorular

Hangi kimlik doğrulama yöntemi kullanılıyor?

API, tüm entegrasyonlar için modern güvenlik standartlarını sağlamak amacıyla OAuth 2.0 kimlik doğrulamasını kullanır.

Teknik dokümantasyon mevcut mu?

Evet, OpenAPI/Swagger tanımları da dahil olmak üzere kapsamlı geliştirici dokümantasyonuna Entegrasyonlar Portalı üzerinden ulaşılabilir.

API erişimini kimler kurabilir?

Yalnızca kuruluşun süper yöneticileri API istemci erişimi sağlayabilir; bu da entegrasyon güvenliğinin sıkı bir şekilde kontrol edilmesini sağlar.

Özetle

• API, veri iş akışlarını otomatikleştirmek için SchoolsBuddy dahili veya üçüncü taraf sistemlerle bağlar.
• Şu anda Öğrenciler, Personel, Etkinlikler, Mekanlar, Gruplar ve Tercihli ve Anında Kayıt seçeneklerini kapsamaktadır.
• Erişim, yalnızca Kuruluş Süper Yöneticileri tarafından OAuth 2.0 aracılığıyla sağlanır.

SchoolsBuddy Genel API'si ile okulunuzun operasyonel verimliliğini artırın.