OpenApplyの公開APIと機能拡張

Faria Education Groupは、 OpenApplyアカウントの設定画面（設定 > 開発 > 公開APIまたはAPIドキュメント）から直接、公開APIのサポートを提供しています。

公開API一式に加え、それらを使ってよく依頼されるタスクを実行する方法を解説したサポート記事も提供しています。

以下に、指示の例をいくつか示します。

Faria Education Group API の活用：統合ポータル

Faria Education Groupは、 OpenApply 、 ManageBac 、 SchoolsBuddy向けに堅牢なAPIを提供しており、幅広い統合および自動化ニーズに対応しています。Faria Faria 、合理化されたブラウザベースの操作性を実現する統合ポータルから始めることを推奨しています。このポータルでは、お客様自身の認証情報を使用したエンドポイントのライブテストも可能です。

統合ポータル：推奨されるアプローチ

インテグレーションポータルは、ブラウザ上で直接、インタラクティブなAPI探索とライブテストを行うために設計されています。

主なメリット：

• ソフトウェアのインストールは不要です。すべてブラウザ上で動作します。
• ライブ「テストする」ボタン： APIエンドポイントを即座に試して、実際の応答を確認できます。
• 安全な認証情報管理：独自のAPIキーまたはOAuth認証情報を使用して認証を行います。
• 即時フィードバック： APIの動作をリアルタイムでトラブルシューティングし、理解できます。

始め方：

1. 統合ポータルにアクセスしてください。
2. 製品を選択してください（ OpenApply 、 ManageBac 、 SchoolsBuddy ）。
3. APIドキュメントを参照し、エンドポイントを選択してください。
4. 「テストする」ボタンをクリックしてください。
5. 認証情報を入力してください（設定方法については下記を参照）。
6. 必要な項目を入力し、リクエストを送信してください。
7. ポータル上でリアルタイムの応答を直接確認できます。

認証設定:

• OpenApply v3:
  • OpenApply > 統合 > 公開API に移動してください。
  • 公開APIを有効にし、新しいOAuthアプリケーションを追加して、クライアントIDとシークレットを生成します。
  • 「アプリケーションの追加」と「変更の保存」を選択すると、クライアントIDとクライアントシークレットが表示されます。
  • 連携機能でホスト名の入力を求められた場合は、学校のOpenApplyアドレス（例：yourschool.openapply.com）を入力してください。
  • OpenApply v3 API認証ガイド
• ManageBac+ v2:
  • ManageBac > 設定 > 統合 > APIアクセス に移動してください。
  • APIキーを生成または取得します。
  • ManageBac+ v2 API認証ガイド
• SchoolsBuddy :
  • SchoolsBuddy > 設定 > APIマネージャー > 「追加」をクリック
  • クライアントIDとシークレットを生成してください。

  • SchoolsBuddy API認証ガイド

レート制限

OpenApply APIでは、3秒に1回のリクエストしか許可されていません。これよりも速いペースでリクエストを送信すると、APIはHTTP 429エラーを返します。制限内に収まるように、統合にスリープまたはレートリミッターを追加してください。レート制限とページネーションに関するガイドは、統合ポータルに掲載されています。

APIで更新可能なフィールド、応答ステータスコード、および現在のエンドポイント参照については、統合ポータルのOpenApplyセクションを参照してください。その他の学生フィールドを一括更新するには、ExcelまたはCSVインポートを使用してください。

学生エンドポイントのフィルタリング

• since_date 、指定された日付以降に更新された学生を返します。
• since_id 、指定したIDよりも大きいIDを持つ学生を返します。
• statusフィルターは、ステータスラベルまたは数値コードを使用して、学生のステータスに基づいてフィルタリングします。卒業または退学した学生を返すには、このパラメーターが必要です。

OpenApplyからAPI経由で学生関連ファイルを取得する方法

問題点： OpenApplyは入学手続きの入り口として使用され、保護者はパスポート写真やその他の詳細情報をアップロードします。これらのデータを別のシステムに保存したり、学校のSIS（学生情報システム）またはMIS（管理情報システム）プラットフォームにアップロードしたりできるようにしたいと考えています。

解決策： OpenApplyは、すべてのファイルを一括エクスポートできる機能がありますが、自動化されたプロセスをお探しの場合は、APIを使用して実現できます。

注：

• OpenApplyでAPIアクセスが有効になっています（管理者権限が必要です）。
• OpenApplyで生成されたOAuth 2.0クライアントIDとシークレット：
• APIリクエストと認証に関する知識

API認証ガイド

手順：

1. APIを使用して、フィルタリング機能や前回呼び出し以降の更新情報など、すべての学生情報を取得できます。この学生情報には、申請フォームに提出されたPDFファイルへの秘密のリンクが含まれています。
2. その後、これらのアセットを安全にダウンロードしたり、ディスクに保存したり、ターゲットプラットフォームにアップロードしたりできます。

API経由で学生ファイルを取得する
特定の学生のファイルをエクスポートするには：

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

• {id}学生のOpenApplyデータベースIDに置き換えてください。
• since_dateパラメータを使用すると、前回のエクスポート以降に更新されたファイルのみを取得できます。

例：

 curl -X GET "https://api.openapply.com/api/v3/students/12345/files?since_date=2026-01-01" \
-H "認証: Bearer YOUR_ACCESS_TOKEN"

レスポンスには各ファイルのメタデータと安全なURLが含まれており、必要に応じてダウンロードして処理できます。

APIリファレンス – ファイル

エクスポートの自動化とスケジュール設定

• 新規ファイルまたは更新されたファイルのみを取得するには、 since_dateパラメータを使用します。
• 対象システムを常に最新の状態に保つため、統合処理を定期的に（例えば毎晩）実行するようにスケジュール設定してください。
• API認証情報は安全に保管し、必要に応じてローテーションしてください。

セキュリティのベストプラクティス

カスタムフィールドをダウンロードする方法と、カスタムフィールドで検索する方法

問題： OpenApplyでは、学校は貴重なデータを入力できるカスタムフィールドを無制限に作成できます。OpenApply OpenApply豊富なエクスポート機能もサポートしていますが、プロセスを自動化するために、APIを使用してデータワークフローを管理するにはどうすればよいでしょうか？

解決策：この記事では、 OpenApply APIとv3認証を使用してカスタムフィールドの情報を取得する方法を示します。学生エンドポイントには、その学生に対して存在するすべてのカスタムフィールドとその値が含まれます。さらに、検索エンドポイントを使用して、カスタム値が文字列に一致する学生を取得することもできます。