Diğer sistemlere bağlanmak için ManageBac+ Genel API'sini kullanın. API belirteçleri oluşturup yönetin ve desteklenen alanları ve izinleri bulun.
ManageBac+ genel API'sinin nasıl çalıştığını, API belirteçlerinin nasıl oluşturulacağını ve 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ğlamasına olanak tanır.
Bu ayarları yalnızca okulunuzun hesabındaki bir yönetici yapılandırabilir. Bu kılavuzda kurulum, belirteç yönetimi, desteklenen işlevler, teknik notlar, izinler ve sık sorulan sorular yer almaktadı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 belirteçler oluşturabilir, izinleri kontrol edebilir, belirteç durumunu inceleyebilir, referans belgelerine erişebilir ve API değişiklik günlüğünü görüntüleyebilirsiniz.
Ayarlar > Geliştir'de artık iki API yöneticisi var. API Manager (Legacy) bu kılavuzda açıklanan API belirteçlerini oluşturur. API Manager (OAuth2) OAuth2 kimlik bilgilerini yayınlar. Bağladığınız sistemin desteklediği sistemi kullanın.
Temel Kavramlar / Yenilikler
Desteklenen alanlar ve işlevler
Örnek istekler ve yanıtlar içeren notlar da dahil olmak üzere, API bağlantılarını ayarlama konusunda ayrıntılı rehberlik için sol menüden Referans Dokümanlar sekmesini açın. Bu sayfada ayrıca 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ü bulunur.
API izinleri
İzin alanları için Hiçbiri'ni, yalnızca Salt Okunur haklarına sahip olanları veya Tümü'nü seçebilirsiniz. Onay kutusunu işaretleyerek alanları tek tek de seçebilirsiniz.
Öğrenciler
- dizin
- göstermek
- yaratmak
- güncelleme
- arşiv
- arşivden çıkar
Ebeveynler
- dizin
- göstermek
- yaratmak
- güncelleme
- arşiv
- arşivden çıkar
Öğretmenler
- dizin
- göstermek
- yaratmak
- güncelleme
Yıl Grupları
- dizin
- danışmanlar
- öğrenciler
- öğrenci ekleme
- öğrencileri kaldır
- dönem devamı
- tarih-katılım
Sınıflar
- dizin
- göstermek
- öğrenciler
- öğrenci ekleme
- öğrencileri kaldır
- dönem devamı
- tarih-katılım
Sınıf değerlendirmeleri
- sınıf-dönem notları
Üyelikler
- dizin
Okul
- göstermek
- akademik yıllar
- konular
- notlar
Görevler
- indeksshowöğrenciler
API işlevleri
Yıl Grupları
- Tüm Yıl Gruplarını Alın
- Danışman Alın
- Bir Yıllık Grup İçin Öğrenci Kazanın
- Bir Yıl Grubuna Öğrenci Ekleme
- Bir Yıl Grubundan Öğrencileri Kaldırma
- Bir Yıllık Grup ve Dönem için Sınıfa Devam Edin
- Belirli bir Tarihte Bir Yıl Grubu için Sınıfa Devam Edin
Sınıflar
- Tüm Sınıfları Alın
- Bir Sınıf Alın
- Bir Sınıfa Öğrenci Kazanın
- Bir Sınıfa Öğrenci Ekleme
- Öğrencileri Sınıftan Kaldırma
- Bir Sınıf için Görevler Alma
- Bir Sınıf için Görev Alma
- Bir Görev ve Sınıf için Öğrenci Değerlendirme Sonuçlarını Alma
- Bir Dersin Dönem Notlarını Alma
- Akademik Dönem Boyunca Bir Sınıfın Tüm Notlarını Alın
- Akademik Dönem Boyunca Derse Devam Edin
- Bir Tarih İçin Derse Katılım Alın
Üyelikler
- Tüm Üyelikleri Alın
Öğrenciler
- Tüm Öğrencileri Alın
- Öğrenci Alın
- Yeni Öğrenci Oluştur
- Bir Öğrenciyi Güncelleme
- Bir Öğrenciyi Arşivle
- Bir Öğrenciyi Arşivden Çıkarma
Öğretmenler
- Tüm Öğretmenleri Alın
- Bir Öğretmen Alın
- Yeni Öğretmen Oluştur
- Öğretmen Güncelleme
Ebeveynler
- Tüm Ebeveynleri Alın
- Ebeveyn edinin
- Yeni Ebeveyn Oluştur
- Bir Ebeveyni Güncelleme
- Bir Ebeveyni Arşivle
- Bir Ebeveyni Arşivden Çıkarma
Okul
- Okul Detaylarını Alın
- Akademik Yılları Alın
- Okul Notlarını Alın
- Okul Konularını Alın
Yardımcı programlar
- ping
- Avatarı Alın
API değişiklik günlüğü
API değişiklik günlüğünü ManageBac+ 'da Ayarlar > Geliştir > API Manager (Legacy) seçeneğine giderek 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 en 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 jeton ekleyin
- Ayarlar > Geliştir > API Manager (Legacy) > Yeni Belirteç Ekle seçeneğine gidin.
- Yeni Belirteç Ekle'yi tıklayın.
- Açık ve kullanışlı bir jeton adı girin, böylece jetonun ne için kullanıldığını kolayca tanımlayabilirsiniz.
- Öğ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.
- Belirteci oluşturmak için Belirteç Ekle'ye tıklayın.
API belirtecini düzenleme veya yönetme
- Ayarlar > Geliştir > API Manager (Legacy) öğesini açın.
- Belirteci başka bir güvenilir sistemde kullanmak üzere kopyalamak için pano simgesini kullanın.
- Belirteç izinlerini görüntülemek için i simgesinin üzerine gelin.
- Etkin mi yoksa devre dışı mı olduğunu görmek için belirteç durumunu inceleyin.
- İzinleri ayarlamak veya belirteci devre dışı bırakmak veya etkinleştirmek için Düzenle'ye tıklayın.
- Entegrasyona artık ihtiyaç duyulmadığında çöp kutusu simgesini kullanarak jetonu 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 e-postayla gönderilmemeli veya SSL şifrelemesi olmayan formlara kaydedilmemelidir. Bir entegrasyon artık kullanılmadığında, sil simgesine tıklayarak API belirtecini devre dışı bırakmanızı öneririz.
API notları
- Boş değerler hiçbir zaman işlenmez.
- POST isteklerinde boş değerler göz ardı edilir.
- Boş dize değerleri göz ardı edilmez ve mevcut değerlerin üzerine yazılır.
- Toplu atama için bir kullanıcı bulunamayan herhangi bir çağrı, örneğin parent_ids veya child_ids gibi bir hata döndürür.
- AND mantığını kullanan indeks eylemleri yığını için mevcut parametreler. Silme işlemi kayıt değiştirme zaman damgasını değiştirmediğinden, değiştirilmiş_since ve silinmiş_since'nin aynı anda kullanılması beklenen sonucu döndürmeyebilir.
- Yönetici rolüne sahip tüm kullanıcılar, güvenlik nedeniyle API aracılığıyla salt okunurdur.
- Tüm zaman damgası alanları ISO8601 biçimindedir; örneğin yyyy-mm-ddThh:mm:ss.sssTZ 2017-11-06T04:35:00.000GST gibi.
- API ile ilgili sorularınız veya endişeleriniz varsa lütfen api@managebac.com ile iletişime geçin.
Oran sınırı
API istek sınırı, aynı IP adresinden dakikada 200 istektir.
Sıkça Sorulan Sorular
ManageBac+ başka bir platformla entegre oluyor mu?
Ürün Ayarlar > Entegrasyonlar > İş Ortakları altında listelenmiyorsa resmi bir ilişki yoktur. Bu durumlarda okulunuz yine de genel API'yi kullanarak özel bir entegrasyon kurabilir.
ManageBac+ Desteği okulumuz için bir entegrasyon oluşturabilir mi?
ManageBac+ ile hangi sistemi entegre etmek istediğinizi bize bildirin; biz de şirket ve ürün olarak bu araç veya hizmetle doğrudan ortak olmanın bizim için anlamlı olup olmadığına karar verelim.
ManageBac+ Desteği bizim için API isteğini yazabilir mi?
ManageBac+ Destek ekibi API soruları ve sorunları hakkında rehberlik sağlayabilir ancak tüm API isteklerinin doğrudan okulunuz tarafından tamamlanması gerekir. Özel bir bağlantı kuruyorsanız lütfen BT departmanınıza danışın.
ManageBac+ API hız limiti nedir?
API istek sınırı, aynı IP adresinden dakikada 200 istektir.
ManageBac+ genel API'sinin nasıl kullanılacağına ilişkin kılavuzu nerede bulabilirim?
Her alanla ilgili ayrıntılar ve en son değişiklik günlüğü notları için lütfen Ayarlar > Geliştir > Referans Dokümanlar'a bakın.
API isteğimde bir sorun var. Kiminle iletişime geçmeliyim?
Lütfen isteğinizin ve karşılaştığınız hatanın net ayrıntılarını içeren 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 sistemlere bağlamasına olanak tanır.
- Belirteçleri Ayarlar > Geliştir > API Manager (Legacy) bölümünden oluşturabilir, inceleyebilir, düzenleyebilir, devre dışı bırakabilir ve silebilirsiniz.
- Referans Dokümanları, izinler, API notları, değişiklik günlüğü ayrıntıları ve ortak destek kılavuzlarının tümüne API Manager iş akışında ulaşılabilir.
ManageBac+ API erişimini güvenli ve izne dayalı tutarken okullara özel entegrasyonlar oluşturmanın kontrollü bir yolunu sunar.