OpenApply Genel API'si ve İşlevselliğinin Genişletilmesi

OpenApply okulların verilerine ve dosyalarına güvenli bir şekilde erişebilmeleri için herkese açık bir API sunmaktadır. İster kurum içinde özel bir programlama ekibiniz (veya daha büyük olasılıkla yetenekli bir tek kişilik ekip!) olsun, ister altyapınızı geliştirmek için üçüncü taraflardan yardım alıyor olun, herkese açık API aracılığıyla OpenApply ile entegre olabilirsiniz.

Faria Education Group OpenApply hesabınızın Ayarlar bölümünden doğrudan Genel API'ye erişim desteği sunmaktadır: Ayarlar > Geliştirme > Genel API veya API Dokümantasyonu

Herkese açık API'lerden oluşan eksiksiz bir paketin yanı sıra, sıkça talep edilen görevleri gerçekleştirmek için bunların nasıl kullanılacağını gösteren destek makaleleri de sunuyoruz.

Aşağıda birkaç talimat örneği verilmiştir.

Faria Education Group API'lerini Keşfetme: Entegrasyonlar Portalı

Faria Education Group OpenApply , ManageBac ve SchoolsBuddy için güçlü API'ler sunarak çeşitli entegrasyon ve otomasyon ihtiyaçlarını desteklemektedir. Faria artık, kendi kimlik bilgilerinizle canlı uç nokta testi de dahil olmak üzere, sorunsuz ve tarayıcı tabanlı bir deneyim için Entegrasyonlar Portalı ile başlamanızı önermektedir.

Entegrasyon Portalı: Önerilen Yaklaşım

Entegrasyon Portalı , doğrudan tarayıcınızda etkileşimli API keşfi ve canlı test yapmanız için tasarlanmıştır.

Başlıca Faydaları:

• Yazılım kurulumu gerekmez: Her şey tarayıcınızda çalışır.
• Canlı "Dene" düğmesi: API uç noktalarını anında deneyin ve gerçek yanıtları görün.
• Güvenli kimlik bilgisi yönetimi: Kendi API anahtarlarınızı veya OAuth kimlik bilgilerinizi kullanarak kimlik doğrulaması yapın.
• Anında geri bildirim: API davranışını gerçek zamanlı olarak sorun giderme ve anlama.

Nasıl Başlanır:

1. Entegrasyonlar Portalı'nı ziyaret edin.
2. Ürününüzü seçin ( OpenApply , ManageBac , SchoolsBuddy ).
3. API dokümantasyonuna göz atın ve bir uç nokta seçin.
4. “Dene” düğmesine tıklayın.
5. Kimlik doğrulama bilgilerinizi girin (kurulum için aşağıya bakın).
6. Gerekli parametreleri doldurun ve isteği gönderin.
7. Canlı yanıtı doğrudan portal üzerinden görüntüleyin.

Kimlik Doğrulama Ayarları:

• OpenApply v3:
  • OpenApply > Entegrasyonlar > Genel API bölümüne gidin.
  • Herkese açık API'yi etkinleştirin ve İstemci Kimliğinizi ve Gizli Anahtarınızı oluşturmak için yeni bir OAuth uygulaması ekleyin.
  • OpenApply v3 API Kimlik Doğrulama Kılavuzu
• ManageBac+ v2:
  • ManageBac > Ayarlar > Entegrasyonlar > API Erişimi bölümüne gidin.
  • API anahtarınızı oluşturun veya alın.
  • ManageBac+ v2 API Kimlik Doğrulama Kılavuzu
• SchoolsBuddy :
  • SchoolsBuddy > Ayarlar > API Yöneticisi > "Ekle" seçeneğine tıklayın.
  • İstemci Kimliğinizi ve Gizli Anahtarınızı oluşturun.

  • SchoolsBuddy API Kimlik Doğrulama Kılavuzu

OpenApply API aracılığıyla öğrenciye ait dosyaları nasıl alabilirim?

Sorun: OpenApply velilerin pasaport fotoğraflarını ve diğer bilgileri yüklediği kayıt sürecinin giriş noktası olarak kullanılıyor. Bu varlıkları başka bir sistemde saklamak veya okulunuzun SIS veya MIS platformuna yüklemek istiyorsunuz.

Çözüm: OpenApply tüm dosyaların toptan dışa aktarılmasını sağlayan bir dışa aktarma özelliği vardır, ancak otomatik bir işlem arıyorsanız, bunu gerçekleştirmek için API'leri kullanabilirsiniz.

Notlar:

• OpenApply API erişimi etkinleştirildi (yönetici izinleri gereklidir).
• OpenApply oluşturulan OAuth 2.0 İstemci Kimliği ve Gizli Anahtarı:
• API istekleri ve kimlik doğrulama konusunda bilgi sahibi olmak.

API Kimlik Doğrulama Kılavuzu

İzlenecek Adımlar:

1. API kullanarak tüm öğrenci bilgilerine erişmeyi, filtrelemeyi ve son çağrıdan bu yana yapılan güncellemeleri almayı destekliyoruz. Bu öğrenci bilgileri, başvuru formuna gönderilen PDF dosyalarına gizli bir bağlantı içerir.
2. Ardından bu dosyaları güvenli bir şekilde indirebilir, diske kaydedebilir veya hedef platforma yükleyebilirsiniz.

API aracılığıyla öğrenci dosyalarını alın
Belirli bir öğrenciye ait dosyaları dışa aktarmak için:

 GET /api/v3/students/{id}/files

• {id} yerine öğrencinin OpenApply veritabanı kimliğini yazın.
• Yalnızca son dışa aktarma işleminden bu yana güncellenen dosyaları getirmek için since_date parametresini kullanın.

Örnek:

 curl -X GET "https://api.openapply.com/api/v3/students/12345/files?since_date=2026-01-01" \
-H "Yetkilendirme: Taşıyıcı YOUR_ACCESS_TOKEN"

Yanıt, her dosya için meta veriler ve güvenli URL'ler içerir; bunları gerektiği gibi indirebilir ve işleyebilirsiniz.

API Referansı – Dosyalar

Dışa Aktarımları Otomatikleştirin ve Planlayın

• Yalnızca yeni veya güncellenmiş dosyaları almak için since_date parametresini kullanın.
• Hedef sisteminizin güncel kalmasını sağlamak için entegrasyonunuzun düzenli aralıklarla (örneğin, her gece) çalışmasını planlayın.
• API kimlik bilgilerini güvenli bir şekilde saklayın ve gerektiğinde değiştirin.

Güvenlikte En İyi Uygulamalar

Özel alanları nasıl indirebilirim ve özel alanlara göre nasıl arama yapabilirim?

Problem: OpenApply ile okullar, değerli verilerle doldurulabilecek sınırsız sayıda özel alan oluşturabilir. OpenApply ayrıca kapsamlı dışa aktarma özelliklerini de desteklerken, süreçleri otomatikleştirmek için API'yi veri iş akışlarımızı yönetmeye yardımcı olacak şekilde nasıl kullanabiliriz?

Çözüm: Bu makale, v3 kimlik doğrulamasıyla OpenApply API'sini kullanarak özel alanlardaki bilgileri nasıl bulacağınızı göstermektedir. Öğrenciler uç noktası, o öğrenci için mevcutsa tüm özel alanları ve değerlerini içerir. Ayrıca, özel değerleri bir dizeyle eşleşen öğrencileri almak için bir arama uç noktası kullanabilirsiniz.