OneRoster プロバイダーの概要
[アーティクル] 03/29/2024
4 人の共同作成者
フィードバック
この記事の内容
OneRoster API (アプリケーション プログラミング インターフェイス) は、学生情報システム (SIS) /学生管理システム (SMS) データの交換のために、1EdTech (旧称 IMS Global) からの業界標準の形式です。 この同期方法を使用すると、SIS/SMS プロバイダーによって開発された REST ベースの OneRoster 1.1 API を使用して、SIS/SMS に直接接続できます。 API サポートを使用すると、CSV (コンマ区切り値) ファイルを使用する代わりに、データを直接同期できます。
OneRoster API を使用してデータを取り込むため、プロビジョニング用のコア SDS 機能を明るくすることができます。 また、Microsoft 365 の製品と機能のエクスペリエンスを強化することもできます。 OneRoster API は、School Data Sync (SDS) プラットフォームを介して OneRoster API を提供する SIS/SMS からオブジェクトを同期する方法です。
OneRoster API をソースとして使用するようにテナントを設定する方法の詳細については、「 OneRoster API を使用したデータ インジェスト 」を参照してください。
OneRoster プロバイダーの状態と機能
[プロバイダー] がドロップダウンに表示されず、状態が [ テスト ] と表示されます。 プロバイダーの一覧に表示するには、何を行う必要がありますか?
カスタマー サポート チーム に連絡してテナントをフライトし、現在テスト 中の API プロバイダーにアクセスします。 要求を発生させるときに、次の情報を共有します。
テナント ID
OneRoster プロバイダー名
SDS バージョン
ロスター
テナントがフライトされたら、OneRoster プロバイダーと SDS POC と連携してテストを実行し、統合が成功したことを確認します。 問題が発生した場合は、プロバイダーと SDS POC を使用して解決してください。
テストが成功すると、OneRoster プロバイダーの状態が (テスト モードからはいに) 更新され、すべてのテナントでパブリックにアクセス可能なプロバイダーの一覧で使用できるようになります。
プロバイダーが一覧に表示されません。 SDS で OneRoster プロバイダーとして参加するために共有する情報はありますか?
名簿データを取り込むときにアクセスされているエンドポイントは何ですか?
次の一覧は、OneRoster API を使用して SIS/SMS に接続するときにアクセスされるデータを理解するのに役立ちます。
SDS に必要な API エンドポイント
アクション
URL
必須のフィルター プロパティ
省略可能/推奨フィルター
例
GetAllAcademicSessions
/academicSessions
status
dateLastModified
/academicSessions?offset=0&limit=5000&filter=status='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}'
GetAllOrgs
/orgs
status
dateLastModified
/orgs?offset=0&limit=5000&filter=status='active'/orgs?filter=dateLastModified>'{deltaDateTime}'
GetAllUsers
/ユーザー
status
dateLastModified
/users?offset=0&limit=5000&filter=status='active'/users?filter=dateLastModified>'{deltaDateTime}'
GetAllClasses
/クラス
status
dateLastModified
/classes?offset=0&limit=5000&filter=status='active'/classes?filter=dateLastModified>'{deltaDateTime}'
GetAllEnrollments
/入学
status
dateLastModified
/enrollments?offset=0&limit=5000&filter=status='active'/enrollments?filter=dateLastModified>'{deltaDateTime}'
SDS 用の省略可能な API エンドポイント
注:
人口統計、学生の連絡先関係、学生ユーザー フラグのオプションのデータの場合、このデータを含めるかどうかは、SIS/SMS OneRoster プロバイダー プロファイルでサポートされているオプションのデータ機能に基づいて行われます。 SIS/SMS プロバイダーもこのデータをサポートしている場合は、トグル (既定値) が [オン] に選択され、追加のデータが含まれます。 必要に応じて、トグルを選択してオフにすることができます。 トグルが使用できない場合、表示はオフで、操作に使用できない場合は、プロバイダーのプロファイルがそのデータの提供を現在サポートしていないことを意味します。
注:
プロバイダーのプロファイルに人口統計、連絡先、またはユーザーの人口統計フラグが利用不可と表示され、その機能をサポートしたい場合は、プロバイダーに問い合わせてサポートの追加を要求して、SDS がデータを取り込み、データサポートのシナリオとエクスペリエンスを有効にできるようにします。
アクション
URL
必須のフィルター プロパティ
省略可能/推奨フィルター
例
GetAllCourses
/コース
status
dateLastModified
/courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics
/人口 統計
status
dateLastModified
/demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}'
省略可能なユーザー学生の連絡先関係
保護者と保護者とのコミュニケーションのための教師エクスペリエンスを強化するために、学生ユーザーに学生の接触関係を指定できます。 連絡先は、/users と共に提供されるより多くのユーザーであり、学生への関連付けは、学生のユーザー レコードの [エージェント] の下にあります。
詳細については、SDS でサポートされている学生の連絡先関係の役割に関するページを 参照してください。既定の値の一覧: 連絡先のリレーションシップ ロールに関するページを参照してください 。
familyName、givenName、および電子メールは、連絡先/保護者ロールを持つユーザーに必要です。
電話とSMSがE.164にあり、+ が含まれている必要があります。 (例: +1234567890)
連絡先関係の保護者レコードから連絡先ユーザーの [エージェント] フィールドの学生に逆データが指定されている場合、これらのレコードは除外されます。
省略可能なユーザー人口統計フラグ
学生ユーザーがプログラムまたはコーホートに参加することを示すために、ユーザー フラグを指定できます。 ユーザー フラグが含まれる (ユーザーに対して true の場合)、または該当しない場合は含まれません。
フラグは、ユーザーのメタデータ拡張機能として、メタデータ フィールドで Key| に従って指定されます。値のペア。 キーの名前は microsoft.userFlags で、コンマ区切りリストとして書式設定する必要があります。 ユーザー フラグは任意の順序で表示され、大文字と小文字は区別されません。
詳細については、SDS でサポートされているユーザー フラグ値の既定の一覧については、「 既定の値の一覧: ユーザー フラグ」を参照してください 。
例:
{
"user" : {
…
…
"metadata" : {
"microsoft.userFlags" : "freeLunch,homeless,giftedOrTalented“
}
}
重要
1EdTech では、データ要求が行われたときに使用可能なデータに対してデータ プライバシーを適用する必要があります。 School Data Sync は、要求の時刻に基づいてアクティブ データの要求を行います。
OneRoster API アクセス資格情報が必要
SIS/SMS の OneRoster API への接続を有効にするには、接続資格情報を指定する必要があります。 詳細については、特定のプロバイダーのドキュメントを参照して取得または生成します。
Web アクセス URL: SIS/SMS で OneRoster API にアクセスできる URL
SIS/SMS OneRoster API への接続に使用されるクライアント ID
SIS/SMS OneRoster API への接続に使用されるクライアント シークレット
アクセス トークン URL。SIS/SMS OneRoster API が OAuth2 を使用した認証用に構成されている場合は、接続に使用するアクセス トークン URL エンドポイントを指定する必要があります。 エンドポイントは Web アクセス URL とは異なります。
役に立つメモとヒント
エンドポイントは常に 'https://{server_URL}/ims/oneroster/v1p1' の後に存在します
SIS から SDS に提供されるデータに特定の学校が含まれるのを防ぐために、お客様はプロバイダーと協力して、SDS を SIS にリンクするために使用される接続/資格情報に含まれる学校を構成する方法を確認する必要があります。
エンドポイントには、状態によるフィルター処理を許可したり、差分同期を有効にしたりするためのフィルター パラメーターのサポートに関する要件があります。
SDS は、差分同期/増分同期処理の dateLastModified プロパティにフィルターを適用し、SDS との統合に必要です。
プロバイダーは、OAuth1(a) または OAuth 2.0 (クライアント資格情報付与) 認証スキームを実装する必要があります。 OAuth 2.0 が推奨されます。
サポートされている認証プロトコルが "OAuth 2.0" である場合 - クライアント資格情報の許可の種類は、SDS によって "Authorization" ヘッダーに資格情報が送信されます。 OneRoster 仕様で推奨されているように、エンコードされたクライアント資格情報をトークン要求の Authorization ヘッダーに送信します。
OneRoster プロバイダーの詳細
Aequitas
SIS ベンダー
Aequitas Solutions, Inc
ソフトウェアの最小バージョン
Q 3.6.1、Q Web API 3.6.0
構成の前提条件
Q Web API の設定に関するページを参照してください
クライアント ID、クライアント シークレット、URL を取得する方法
Q Web API の設定に関するページを参照してください
具体的な手順
該当なし
ヘルプ
サポートにお問い合わせください (909) 946-1600
Aeries
SIS ベンダー
Aeries
ソフトウェアの最小バージョン
v8.18.6.29 以降
構成の前提条件
「OneRoster API のセットアップ 」を参照してください。
クライアント ID、クライアント シークレット、URL を取得する方法
セルフホステッド。
「OneRoster API のセットアップ 」を参照してください。
具体的な手順
該当なし
ヘルプ
電話 (フリーダイヤル): (888) 324-5363 または support@aeries.com
Arbor Education
SIS ベンダー
Arbor Education
ソフトウェアの最小バージョン
該当なし
構成の前提条件
アーバー MIS と SDS の統合は、アーバー MIS で有効になります。
accountmanagers@arbor-education.com経由で有効になっていることを確認するには、Arbor のアカウント マネージャーにお問い合わせください。 Office 365教育テナント、グローバル管理者のアクセス許可、および学校データ同期 (プラン 1) が有効になっている必要があります。
クライアント ID、クライアント シークレット、URL を取得する方法
アーバー MIS で生成します。 完了する手順については、Arbor ヘルプ センターを参照してください。
具体的な手順
myteam@arbor-education.comを使用してこの統合を設定するには、Arbor または専用のサポート パートナーにお問い合わせください。
ヘルプ
アーバーのヘルプ センターでサポート記事をご覧ください。 質問については、 myteam@arbor-education.com または専用サポート パートナーにお問い合わせください。
Blackbaud Education Management
SIS ベンダー
Blackbaud Education Management
ソフトウェアの最小バージョン
BEM の最新バージョンは常にユーザーが利用できます。
構成の前提条件
該当なし
クライアント ID、クライアント シークレット、URL を取得する方法
詳しい手順については、こちらを参照してください。
具体的な手順
Microsoft Entraユーザーのマッピング設定を選択するときは、ドメイン サフィックスを含める/除外する設定が、Microsoft Entraユーザー名と一致していることを確認してください。 このアクションにより、BEM の学生と教師をMicrosoft Entra ユーザーと照合するときに最適な結果が得られます。
ヘルプ
support.blackbaud.com
Bubblecon
SIS ベンダー
Bubblecon
具体的な手順
Bubblecon カスタマー サポート チームへの連絡。
ClassLink
SIS ベンダー
ClassLink
ソフトウェアの最小バージョン
該当なし
構成の前提条件
コンソールに SDS アプリを追加します。 手順については、[ アプリケーションの追加] & [アクセス許可の変更] を選択します。
クライアント ID、クライアント シークレット、URL を取得する方法
お客様は、アプリを追加した後、コンソールから oAuth 資格情報を取得できます。 アプリを設定した Microsoft の開発者に電子メールが送信されます。 [ アプリケーションの追加] & [アクセス許可の変更] を選択して、クライアント ID とシークレットを取得する場所を表示します。
接続に問題がある場合は、Web アクセス URL に正しいコネクタを指す "/ims/oneroster/v1p1" があることを確認します。
具体的な手順
該当なし
ヘルプ
電子メール rostersupport@classlink.com。
Classter
Edge Learning
SIS ベンダー
Edge Learning
ソフトウェアの最小バージョン
Edge は Web アプリケーションであり、最小バージョンは必要ありません。
構成の前提条件
OneRoster 経由でMicrosoft 学校データ同期エッジ アプリケーションの "ヘルプ" から入手できます
クライアント ID、クライアント シークレット、URL を取得する方法
OneRoster 経由でMicrosoft 学校データ同期エッジ アプリケーションの "ヘルプ" から入手できます
具体的な手順
OneRoster 経由でMicrosoft 学校データ同期エッジ アプリケーションの "ヘルプ" から入手できます
ヘルプ
OneRoster 経由でMicrosoft 学校データ同期エッジ アプリケーションの "ヘルプ" から入手できます
コミュニティ ブランドによる教育
SIS ベンダー
コミュニティ ブランドによる教育
ソフトウェアの最小バージョン
該当なし
構成の前提条件
該当なし
クライアント ID、クライアント シークレット、URL を取得する方法
カスタマー サポートにお問い合わせください。
具体的な手順
カスタマー サポートにお問い合わせください。
ヘルプ
サポートについては、 educate_support@communitybrands.comにお問い合わせください。
Edulife Connect
SIS ベンダー
Edulife Connect
ソフトウェアの最小バージョン
該当なし
構成の前提条件
該当なし
クライアント ID、クライアント シークレット、URL を取得する方法
デプロイとサポート チームと直接連絡を取って行います。
具体的な手順
該当なし
ヘルプ
support@wizkids.co.ukでサポートにお問い合わせください。 // 020 7550 9286
eSchoolData
SIS ベンダー
eSchoolData
ソフトウェアの最小バージョン
該当なし
構成の前提条件
地区は、eSD GURU 製品のサブスクライバーである必要があります。
クライアント ID、クライアント シークレット、URL を取得する方法
具体的な手順を参照してください。
具体的な手順
SDS との API 統合を有効にするには、地区管理者が最初に GURU 内にベンダー アカウントを作成する必要があります。 [構成] > [仕入先] に移動し、[新しい仕入先の作成] を選択します。 ベンダー名を入力し、自動的に生成されるクライアント ID とクライアント シークレットを保持します。 SDS 統合を構成するときに、リージョンの GURU API URL と共にを指定します。 [次へ] を選択し、すべての OneRoster API アクセス許可を有効にします。 完了したら [完了] を選択して、新しいアカウントを保存します。
ヘルプ
質問については、eSchoolData サポート チームにお問い合わせください。
eSchooling
SIS ベンダー
Codevision による eSchooling
ソフトウェアの最小バージョン
1.1.20
構成の前提条件
なし
クライアント ID、クライアント シークレット、URL を取得する方法
eSchooling プラットフォームの指示に従う: System Administration > School Data Sync
具体的な手順
以前と同じ
ヘルプ
接触 suporte@codevision.pt
エウムスクールSIS
SIS ベンダー
DataEum
ソフトウェアの最小バージョン
該当なし
構成の前提条件
なし
クライアント ID、クライアント シークレット、URL を取得する方法
カスタマー サポートEmail OneRoster API の資格情報を要求します。
具体的な手順
カスタマー サポートに問い合わせる pbd@dataeum.kr
ヘルプ
カスタマー サポートに問い合わせる pbd@dataeum.kr
Eventful
SIS ベンダー
Eventful
ソフトウェアの最小バージョン
サポートされている学生登録の一覧は、 Eventful OneRoster にあります。
構成の前提条件
info@eventful.seまたは電話 (+46) 10 209 9001 で電子メールで Eventful に連絡する
クライアント ID、クライアント シークレット、URL を取得する方法
セットアップ プロセスで提供されます。
具体的な手順
該当なし
ヘルプ
info@eventful.seまたは電話(+46)10 209 9001で電子メールでイベントフルサポートにお問い合わせください
事実
SIS ベンダー
事実
ソフトウェアの最小バージョン
該当なし。 最新バージョンは常に顧客が利用できます。
構成の前提条件
該当なし
クライアント ID、クライアント シークレット、URL を取得する方法
お客様が OneRoster API にサインアップすると、FACTS によってこの情報が提供されます。
具体的な手順
SIS 内から、[System > Configuration > SIS Integrations > OneRoster API > [入力] フォームに移動します。
ヘルプ
カスタマー サポート 866-800-6593
Focus School Software
SIS ベンダー
Focus School Software
ソフトウェアの最小バージョン
フォーカス v 8.7
構成の前提条件
該当なし
クライアント ID、クライアント シークレット、URL を取得する方法
[フォーカス] ポータル画面で、[セットアップ] > [システムのセットアップ] > [サード パーティ システム] を選択します。 レコード挿入行に、「Title: Microsoft Version 1.0 > Dialect: OneRoster」と入力します。 保存すると、URL、クライアント ID、クライアント シークレットが生成されます。
具体的な手順
該当なし
ヘルプ
877-410-6637 で Focus の電話サポートラインを呼び出します。
Follett Aspen
SIS ベンダー
Follett Aspen
ソフトウェアの最小バージョン
Aspen の最新バージョン、5.9
構成の前提条件
該当なし
クライアント ID、クライアント シークレット、URL を取得する方法
アップグレードをスケジュールするには、地区のカスタマー リレーションシップ マネージャーにお問い合わせください。
具体的な手順
該当なし
ヘルプ
カスタマー リレーションシップ マネージャーにお問い合わせください。
ファーロンスクールベース
SIS ベンダー
ファーロンスクールベース
ソフトウェアの最小バージョン
最新バージョンのみを使用するホストされている学校
構成の前提条件
該当なし
クライアント ID、クライアント シークレット、URL を取得する方法
手順については、 こちらを参照してください 。
具体的な手順
該当なし
ヘルプ
ファーロング でチケットを開きます。
INACAP SDS API
SIS ベンダー
INACAP SDS API
ソフトウェアの最小バージョン
該当なし
構成の前提条件
該当なし
クライアント ID、クライアント シークレット、URL を取得する方法
INACAP 用のオンプレミス システムは、必要に応じて sistemas@inacap.cl にお問い合わせください。
具体的な手順
該当なし
ヘルプ
sistemas@inacap.clにメールで INACAP サポートにお問い合わせください。
Infinitas Learning
Infinite Campus
SIS ベンダー
Infinite Campus
ソフトウェアの最小バージョン
名簿プロビジョニングの場合、最小バージョンは Campus.1821 です。
構成の前提条件
OAuth クライアントの作成
クライアント ID、クライアント シークレット、URL を取得する方法
サインインして oAuth 構成画面の最新の製品ドキュメントを見つけるには、「Infinite Campus の OneRoster ガイダンス」 を参照してください。
具体的な手順
V 1933.3 より前のバージョン - Infinite Campus ユーザー インターフェイスに移動 >> [システム管理] を選択 >> 、[Campus Learning] を選択 >> [OneRoster Tools]\(OneRoster ツール\) を選択 >> [OneRoster] を選択します。 バージョン 1933.3 以降 - Infinite Campus ユーザー インターフェイスに移動 >> [システム管理] を選択 >> [相互運用性の学習] を選択します
同期する Infinite Campus 内の属性を選択するときは、期間が選択 されていないこと を確認します。 選択されている場合は、検疫でプロファイルを同期およびロックするときに多数のエラーが発生する可能性があります。
ヘルプ
ヘルプについては、カスタマー サクセス マネージャーにお問い合わせください。
inLogic
iSAMS by IRIS
SIS ベンダー
iSAMS by IRIS
ソフトウェアの最小バージョン
21.4.23.12
構成の前提条件
なし
クライアント ID、クライアント シークレット、URL を取得する方法
OneRoster API の資格情報を要求するヘルプデスクに電子メールを送信する必要があります。 helpdesk@isams.co.uk
具体的な手順
なし
ヘルプ
helpdesk@isams.co.ukでヘルプ ドキュメントを依頼するには、iSAMS ヘルプデスクにお問い合わせください。
IST
SIS ベンダー
IST
ソフトウェアの最小バージョン
該当なし。
構成の前提条件
具体的な手順を参照してください。
クライアント ID、クライアント シークレット、URL を取得する方法
具体的な手順を参照してください。
具体的な手順
セットアップに関する情報は非公開で提供されます。
ヘルプ
質問については、IST サポート チームにお問い合わせください。
LIBRUS
SIS ベンダー
LIBRUS
ソフトウェアの最小バージョン
現在のバージョン
構成の前提条件
クライアントは LIBRUS Synergia のライセンスを持っている必要があります
クライアント ID、クライアント シークレット、URL を取得する方法
SDS との API 統合を有効にするには、管理者または学校プリンシパルとしてログインする必要があります。 [設定] > [構成] > [その他のオプション> Office 365統合] に移動します
具体的な手順
詳細な手順については、ヘルプ セクションを参照してください。
ヘルプ
サポート チームにお問い合わせください。 pomoc@LIBRUS.pl
MySchool
SIS ベンダー
MySchool Ltd
ソフトウェアの最小バージョン
該当なし
構成の前提条件
サポート チームを通じて支援された MySchool システムの初期セットアップ。
クライアント ID、クライアント シークレット、URL を取得する方法
サポート チームを通じて支援。
具体的な手順
サポートについては、こちらを参照してください。
ヘルプ
お問い合わせ
Rediker Software
SIS ベンダー
TeacherPlus Gradebook by Rediker Software
ソフトウェアの最小バージョン
1.12.0.0
構成の前提条件
なし。 OneRoster 統合は、既定ですべての学校で有効になっています。
クライアント ID、クライアント シークレット、URL を取得する方法
新しい学校が作成されたときにプログラムによって自動生成されます。 管理は、Gradebook Manager アプリケーションを使用してユーザー設定を管理できます。
具体的な手順
なし
ヘルプ
質問は、 GBSupport@rediker.com または APSupport@rediker.com
SIMS
Skool
SIS ベンダー
Skool
ソフトウェアの最小バージョン
School Data Sync を有効にするには、Miloo+ サービスが必要です
構成の前提条件
Skool でアカウント マネージャーに問い合わせて、SDS を設定して有効にします。
クライアント ID、クライアント シークレット、URL を取得する方法
該当なし
具体的な手順
該当なし
ヘルプ
Skool サポート (+31) 40 750 77 77 77 または電子メール ( servicedesk@skool.nl) にお問い合わせください。
Skyward
SmartSchool
SIS ベンダー
SmartSchool
ソフトウェアの最小バージョン
製品は SaaS ソリューションであり、すべてのクライアントに最新バージョンがあります
構成の前提条件
特定の前提条件なし
クライアント ID、クライアント シークレット、URL を取得する方法
ソフトウェアで、[全般構成]、[OneRoster クライアント] の各ページに移動し、指示に従います。
具体的な手順
該当なし
ヘルプ
お客様は、既知のサポート チャネルから SmartSchool に連絡できます。
Synergy SIS
SIS ベンダー
Edupoint による相乗効果 SIS
ソフトウェアの最小バージョン
2022
構成の前提条件
OneRoster API ライセンス キー
クライアント ID、クライアント シークレット、URL を取得する方法
Edupoint サポートにお問い合わせください
具体的な手順
該当なし
ヘルプ
https://support.edupoint.com/
Trivium
SIS ベンダー
Trivium
ソフトウェアの最小バージョン
1.0
構成の前提条件
構成については、Trivium - Microsoft Partner にお問い合わせください。
クライアント ID、クライアント シークレット、URL を取得する方法
Trivium - Microsoft Partner に問い合わせて、クライアント ID とシークレットを生成します。
具体的な手順
なし
ヘルプ
https://www.trivium.com.br/contato/ と suporte@trivium.com.br
Vigilo
SIS ベンダー
Vigilo
ソフトウェアの最小バージョン
なし
構成の前提条件
なし
クライアント ID、クライアント シークレット、URL を取得する方法
Vigilo にお問い合わせください。
具体的な手順
なし
ヘルプ
プロセスを通じてサポートについては、Vigilo にお問い合わせください。
Visma InSchool
SIS ベンダー
Visma Enterprise AS
ソフトウェアの最小バージョン
なし
構成の前提条件
なし
クライアント ID、クライアント シークレット、URL を取得する方法
Visma サポートにお問い合わせください
具体的な手順
Visma サポートにお問い合わせください
ヘルプ
https://inschool.zendesk.com の Visma サポートにお問い合わせください。
VULCAN UONET+
SIS ベンダー
VULCAN UONET+
ソフトウェアの最小バージョン
Current
構成の前提条件
クライアントは UONET+ のライセンスを持っている必要があります
クライアント ID、クライアント シークレット、URL を取得する方法
バルカン 管理 ポータルから。API exchange 構成> [Office 365設定] > [構成] を選択します。 "Office 365との同期" を有効にします。 このタブでは、クライアント ID、クライアント シークレット、および URL を受け取ります。
具体的な手順
該当なし
ヘルプ
標準営業時間中 https://vulcan.edu.pl サポートにお問い合わせください。