ManageBac+ Genel API'si
ManageBac+ genel API'sinin nasıl çalıştığını, API belirteçlerinin nasıl oluşturulup yönetileceğini ve desteklenen alanlar, işlevler, izinler, notlar ve değişiklik günlüğü bilgilerinin nerede bulunacağını öğrenin.
ManageBac+ genel API'si, okulların ManageBac+ hesaplarını ManageBac+ ile doğrudan entegre olmayan harici platformlara bağlamalarına olanak tanır.
Bu ayarları yalnızca okulunuzun hesabındaki bir yönetici yapılandırabilir. Bu kılavuz, kurulum, belirteç yönetimi, desteklenen işlevler, teknik notlar, izinler ve sık sorulan soruları kapsamaktadır.
Genel Bakış
ManageBac+ genel API'si, üçüncü taraf sistemlerle özel bağlantılar kurması gereken okullar için tasarlanmıştır. API erişimi, yöneticiler tarafından oluşturulan ve yönetilen belirteçler aracılığıyla kontrol edilir.
API Yöneticisi'nden token oluşturabilir, izinleri kontrol edebilir, token durumunu inceleyebilir, referans belgelere erişebilir ve API değişiklik günlüğünü görüntüleyebilirsiniz.
Temel Kavramlar / Yenilikler
Desteklenen alanlar ve işlevler
API bağlantılarının kurulumuyla ilgili ayrıntılı kılavuz için sol menüden "Referans Belgeleri" sekmesini açın. Bu sekmede örnek istekler ve yanıtlar içeren notlar da bulunmaktadır. Ayrıca bu sayfada, farklı API sürümleri için listelenen mevcut istekleri kullanabilmeniz için üst kısımda bir sürüm açılır menüsü de yer almaktadır.
API izinleri
İzin alanları için "Hiçbiri"ni seçebilir, yalnızca "Salt okunur" haklarına sahip olanları seçebilir veya "Tümünü" seçebilirsiniz. Ayrıca, onay kutusunu işaretleyerek tek tek alanları da seçebilirsiniz.
Öğrenciler
- indeks
- göstermek
- yaratmak
- güncelleme
- arşiv
- arşivden çıkar
Ebeveynler
- indeks
- göstermek
- yaratmak
- güncelleme
- arşiv
- arşivden çıkar
Öğretmenler
- indeks
- göstermek
- yaratmak
- güncelleme
Yıl Grupları
- indeks
- danışmanlar
- öğrenciler
- öğrenci ekle
- öğrencileri kaldır
- dönem devamı
- tarih-katılım
Sınıflar
- indeks
- göstermek
- öğrenciler
- öğrenci ekle
- öğrencileri kaldır
- dönem devamı
- tarih-katılım
Sınıf değerlendirmeleri
- notlar dönem notları
Üyelikler
- indeks
Okul
- göstermek
- akademik yıllar
- konular
- notlar
Görevler
- indexshowstudents
API fonksiyonları
Yıl Grupları
- Tüm Yıl Gruplarını Alın
- Danışman Edinin
- Bir yıl grubuna öğrenci bulun.
- Öğrencileri bir sınıf grubuna ekle
- Öğrencileri bir sınıf düzeyinden çıkarın
- Bir sınıf ve dönem için sınıf devamsızlık bilgilerini alın.
- Belirtilen Tarihte Bir Sınıfın Sınıf Devamsızlık Bilgilerini Alın
Sınıflar
- Tüm dersleri alın
- Bir Sınıf Edinin
- Bir ders için öğrenci bulun
- Sınıfa Öğrenci Ekleme
- Öğrencileri Sınıftan Çıkarma
- Bir Sınıf İçin Görevler Alın
- Bir Ders İçin Görev Alın
- Bir görev ve ders için öğrenci değerlendirme sonuçlarını alın.
- Bir Dersin Dönem Notlarını Alın
- Bir akademik dönem boyunca bir derse ait tüm notları alın.
- Akademik dönem boyunca bir dersin yoklamasını alın.
- Belirli Bir Tarih İçin Ders Devamsızlık Bilgilerini Alın
Üyelikler
- Tüm üyelikleri edinin
Öğrenciler
- Tüm öğrencileri alın
- Bir Öğrenci Edinin
- Yeni Öğrenci Oluştur
- Öğrenciyi Güncelle
- Öğrenci Arşivi
- Öğrenci Arşivinden Çıkarma
Öğretmenler
- Tüm Öğretmenleri Alın
- Bir Öğretmen Edinin
- Yeni Öğretmen Oluştur
- Öğretmeni Güncelle
Ebeveynler
- Tüm ebeveynleri alın
- Bir Ebeveyn Edinin
- Yeni Ebeveyn Oluştur
- Ebeveyni bilgilendirin
- Üst öğeyi arşivle
- Üst öğeyi arşivden çıkar
Okul
- Okul Bilgilerini Alın
- Akademik Yılları Alın
- Okul Notlarını Al
- Okul Dersleri Alın
Kamu Hizmetleri
- Ping
- Avatar edinin
API değişiklik günlüğü
ManageBac+ ta API değişiklik günlüğünü Ayarlar > Geliştirme > API Yöneticisi yolunu izleyerek görüntüleyebilirsiniz. Bu sayfanın alt kısmında, yeni alanlar, eklenen veya değiştirilen uç noktalar ve diğer ilgili teknik değişiklikler de dahil olmak üzere son API güncellemelerinin kronolojik olarak listelendiği Değişiklik Günlüğü bölümünü bulacaksınız.
Adım Adım Gezinme
ManageBac+ genel API'sini etkinleştirin ve bir belirteç ekleyin.
- Ayarlar > Geliştirme > API Yöneticisi > Yeni Token Ekle yolunu izleyin.
- Yeni Token Ekle'ye tıklayın.
- Tokenin ne için kullanıldığını kolayca belirleyebilmek için açık ve kullanışlı bir token adı girin.
- Öğrenci, veli ve öğretmen verileri, IB Grupları, Sınıflar ve Okul ayarları dahil olmak üzere güncellemek ve almak istediğiniz noktaları seçin.
- Token oluşturmak için "Token Ekle" ye tıklayın.
Bir API belirtecini düzenleyin veya yönetin.
- Ayarlar > Geliştirme > API Yöneticisi'ni açın.
- Güvenilir başka bir sistemde kullanmak üzere belirteci kopyalamak için pano simgesini kullanın.
- Token izinlerini görüntülemek için i simgesinin üzerine gelin.
- Tokenin etkin mi yoksa devre dışı mı olduğunu görmek için durumunu inceleyin.
- İzinleri ayarlamak veya belirteci devre dışı bırakmak/etkinleştirmek için Düzenle'ye tıklayın.
- Entegrasyona artık ihtiyaç kalmadığında, çöp kutusu simgesini kullanarak belirteci silin.
Uyarılar ve Önemli Notlar
Güvenlik uyarısı
API belirteciniz yalnızca güvenilir taraflarla paylaşılmalıdır. API belirteçleri asla SSL şifrelemesi olmadan e-posta ile gönderilmemeli veya formlara kaydedilmemelidir. Bir entegrasyon artık kullanılmadığında, silme simgesine tıklayarak API belirtecini devre dışı bırakmanızı öneririz.
API notları
- Boş değerler asla görüntülenmez.
- POST isteklerinde boş değerler (null) dikkate alınmaz.
- Boş dize değerleri göz ardı edilmez ve mevcut değerlerin üzerine yazılır.
- Toplu atama için kullanıcı bulunamadığında (örneğin parent_ids veya child_ids) yapılan her çağrı hata döndürecektir.
- İndeks işlemleri için kullanılabilen parametreler, AND mantığı kullanılarak bir araya getirilir. modified_since ve deleted_since parametrelerini aynı anda kullanmak beklenen sonucu vermeyebilir, çünkü silme işlemi kayıt değiştirme zaman damgasını değiştirmez.
- Güvenlik nedenleriyle, yönetici rolüne sahip tüm kullanıcılar API üzerinden yalnızca okuma erişimine sahiptir.
- Tüm zaman damgası alanları ISO8601 formatındadır, örneğin yyyy-mm-ddThh:mm:ss.sssTZ, örneğin 2017-11-06T04:35:00.000GST .
- API ile ilgili sorularınız veya endişeleriniz varsa lütfen api@managebac.com adresinden bizimle iletişime geçin.
Hız sınırı
Aynı IP adresinden yapılabilecek API istek limiti dakikada 200 istektir .
Sıkça Sorulan Sorular
ManageBac+ başka bir platformla entegre oluyor mu?
Eğer ürün Ayarlar > Entegrasyonlar > İş Ortakları altında listelenmiyorsa, resmi bir ilişki bulunmamaktadır. Bu durumlarda, okulunuz yine de genel API'yi kullanarak özel bir entegrasyon kurabilir.
ManageBac+ Destek ekibi okulumuz için bir entegrasyon geliştirebilir mi?
ManageBac+ ile hangi sistemi entegre etmek istediğinizi bize bildirin, böylece şirketimiz ve ürünümüz açısından bu araç veya hizmetle doğrudan ortak olmanın mantıklı olup olmadığını değerlendirebiliriz.
ManageBac+ Destek ekibi bizim için API isteğini yazabilir mi?
ManageBac+ Destek ekibi API soruları ve sorunları konusunda rehberlik sağlayabilir, ancak tüm API istekleri doğrudan okulunuz tarafından tamamlanmalıdır. Özel bir bağlantı kuruyorsanız, lütfen BT departmanınıza danışın.
ManageBac+ API'sinin kullanım limiti nedir?
Aynı IP adresinden yapılabilecek API istek limiti dakikada 200 istektir .
ManageBac+ genel API'sinin nasıl kullanılacağına dair kılavuzu nerede bulabilirim?
Her alan ve en son değişiklik notları hakkında ayrıntılı bilgi için lütfen Ayarlar > Geliştirme > Referans Belgeleri bölümüne bakın.
API isteğimde bir sorun var. Kiminle iletişime geçmeliyim?
Lütfen isteğinizin ayrıntılarını ve yaşadığınız hatayı belirterek api@managebac.com adresine e-posta gönderin.
Özetle
- ManageBac+ genel API'si, okulların ManageBac+ yönetici tarafından yönetilen belirteçler aracılığıyla harici sistemlerle bağlamasına olanak tanır.
- Ayarlar > Geliştirme > API Yöneticisi bölümünden token oluşturabilir, inceleyebilir, düzenleyebilir, devre dışı bırakabilir ve silebilirsiniz.
- API Yöneticisi iş akışı içerisinde referans dokümanları, izinler, API notları, değişiklik günlüğü ayrıntıları ve genel destek kılavuzları yer almaktadır.
ManageBac+ okullara API erişimini güvenli ve izin tabanlı tutarken özel entegrasyonlar oluşturmanın kontrollü bir yolunu sunar.