Bu kılavuz SchoolsBuddy API erişiminin nasıl kurulacağını ve yönetileceğini açıklamaktadır. Bu işlem, teknik ekibinizin OAuth 2.0 aracılığıyla kimlik doğrulaması yapmasına ve harici sistemlerinizi SchoolsBuddy bağlamaya başlamasına olanak tanır.

Bu ayarlara erişmek için belirli izinler gereklidir; devam etmeden önce Kuruluş Süper Yöneticisi olarak oturum açtığınızdan emin olun.

Genel Bakış

Herkese Açık API Yöneticisi alanı, Kuruluş Süper Yöneticilerinin yönetimine açıktır. Bu merkezi merkez, okulunuzun veri entegrasyonları için kullanılan istemcileri oluşturacağınız, düzenleyeceğiniz ve güvenliğini sağlayacağınız yerdir.

Temel Kavramlar

Kuruluma başlamadan önce aşağıdaki ön koşulların yerine getirildiğinden emin olun:

• Kuruluş Süper Yöneticisi olarak giriş yaptınız.
• Gerekli izinleri ve kapsamları yapılandırmak için teknik dokümantasyonunuz hazır.

Adım Adım Gezinme

İpuçları ve En İyi Uygulamalar

• Test Ortamı: Canlı SchoolsBuddy örneğinize bağlanmadan önce, mümkünse entegrasyonunuzu her zaman bir test ortamında deneyin.
• Toplu İşlemler: Veri bütünlüğünü sağlamak için toplu yazma işlemlerine başlamadan önce teknik dokümantasyonu iyice inceleyin.
• Kimlik Bilgisi Bakımı: API Yöneticisi içinde, güvenliği sağlamak için izinleri düzenleyebilir, kimlik bilgilerini yeniden oluşturabilir veya istemcileri devre dışı bırakabilir/silebilirsiniz.

Uyarılar ve Önemli Notlar

Güvenlik Erişimi: API kimlik bilgileri, okulunuzun verilerine önemli ölçüde erişim sağlar. Bu ayarları yönetmek için yalnızca yetkili personelin Süper Yönetici erişimine sahip olduğundan emin olun.

Herkese Açık Paylaşım: İstemci Gizli Anahtarınızı asla herkese açık olarak paylaşmayın; bu kimlik bilgileri SchoolsBuddy örneğinize özeldir ve veri ekosisteminize doğrudan erişim sağlar.

İlgili Makaleler

• SchoolsBuddy Genel API'sine Giriş

Sıkça Sorulan Sorular

Müşteri Gizli Bilgilerimi kaybedersem ne olur?

Güvenlik nedenleriyle, SchoolsBuddy istemci gizli anahtarını tekrar göstermez. Bu istemci için kimlik bilgilerini yeniden oluşturmak üzere API Yöneticisini kullanmanız gerekecektir.

API'nin yapabileceklerini sınırlayabilir miyim?

Evet. Yapılandırma sırasında, söz konusu entegrasyon için gerekli olan okuma (GET) veya yazma (POST/PUT) erişimini sağlamak üzere belirli izinler ve kapsamlar tanımlayabilirsiniz.

Özetle

• Ayarlar > API Yöneticisi üzerinden API Yöneticisine erişin.
• Belirli yetkilere sahip yeni bir istemci oluşturarak kimlik bilgilerini oluşturun.
• İstemci kimliklerini ve gizli bilgilerini güvenli bir şekilde saklayın ve asla kamuya açık olarak paylaşmayın.

SchoolsBuddy entegrasyonunuz artık veri senkronizasyonuna başlamaya hazır.