Harici istemci entegrasyonu

Okul yönetim sisteminizden CatchUpper'a öğrenci ve personel aktarımı, ve aktarılan kullanıcının tek tıkla girişi (SSO) için gereken teknik sözleşme.

Genel bakış

Akış üç adımdır.

Kimlik doğrulama. clientId + secret ile 4 saat geçerli bir accessToken alırsınız.
Aktarım. Kullanıcı bilgilerini ve kayıt listesini gönderir, karşılığında bir redirectUrl alırsınız.
Yönlendirme. Kullanıcıyı o adrese gönderirsiniz: öğrenci app.catchupper.com'a, personel admin.catchupper.com'a.

İkinci adım hem oluşturur hem günceller

Aynı kullanıcı için tekrar çağrıldığında yeni kayıt açmaz; mevcut kullanıcıyı bulur, kayıtlarını gönderdiğiniz listeye göre günceller ve yeni bir giriş bağlantısı döner. Bu nedenle her dönem başında tüm listeyi yeniden gönderebilirsiniz.

Yetki sınırı. İstemciniz yalnızca kendi kurumunuza tanımlanmış markaya (brand) bağlı sezonlara kullanıcı aktarabilir. Başka bir markanın sezon numarası gönderilirse istek reddedilir (seasonIsOutsideExternalClientBrandScope). Hangi markaya ve hangi sezonlara yetkili olduğunuzu tarafımızdan teyit edin.

Uç noktalar

POST/management/clients/external/authenticate

POST/management/users/transfer/learner/from-external-client

POST/management/users/transfer/staff/from-external-client

Üçü de Content-Type: application/json ister. Aktarım uç noktaları { "redirectUrl": "..." } döner.

Kimlik doğrulama ile başlayın →

Kimlik bilgileri ve destek

clientId ve secret bu dokümanla birlikte gönderilmez; ayrı ve güvenli bir kanaldan iletilir. Üretim ve test için farklı kimlik bilgileri verilir.
Mevcut bir entegrasyonunuz varsa secret değerinin dönemsel olarak yenilenmesini öneririz. Yenileme anında eski değer geçersiz olur, bu yüzden birlikte planlanmalıdır.
Sezon numaralarını (seasonId) tarafımızdan talep edin; kurum ve sezon eşleşmelerini birlikte netleştirelim.
externalClientHasNoBrandScope ve multipleUsersFoundContactUs hataları bizim tarafımızdaki yapılandırmayla ilgilidir — bu ikisi için bizimle iletişime geçin.