검색

OpenApply 의 공개 API 및 기능 확장

The Faria Team
  • 업데이트 시간

OpenApply 학교에서 데이터를 안전하게 접근하고 파일을 관리할 수 있도록 공개 API를 제공합니다. 전담 프로그래밍 팀을 보유하고 있든 (혹은 재능 있는 1인 개발팀이 있든!), 외부 업체를 통해 인프라를 구축하든 관계없이 공개 API를 통해 OpenApply 와 연동할 수 있습니다.

Faria Education Group OpenApply 계정 설정에서 직접 공개 API에 대한 지원을 제공합니다. 설정 > 개발 > 공개 API 또는 API 문서에서 확인하실 수 있습니다.

스크린샷: Faria Education Group은 OpenApply 계정 설정에서 바로 공개 API에 대한 지원을 제공합니다.

다양한 공개 API 외에도, 자주 요청되는 작업을 수행하기 위해 API를 사용하는 방법을 보여주는 지원 문서도 제공합니다.

다음은 몇 가지 지침 예시입니다.

Faria Education Group API 살펴보기: 통합 포털

Faria Education Group OpenApply , ManageBac 및 SchoolsBuddy 위한 강력한 API를 제공하여 다양한 통합 및 자동화 요구 사항을 지원합니다. Faria 간소화된 브라우저 기반 환경을 제공하는 통합 포털 에서 시작하는 것을 권장합니다. 여기에는 사용자 자격 증명을 사용한 실시간 엔드포인트 테스트도 포함됩니다.

통합 포털: 권장 접근 방식

통합 포털은 브라우저에서 직접 API를 탐색하고 실시간으로 테스트할 수 있도록 설계되었습니다.

주요 이점:

  • 소프트웨어 설치가 필요 없습니다. 모든 기능은 브라우저에서 실행됩니다.
  • 실시간 "테스트" 버튼: API 엔드포인트를 즉시 테스트하고 실제 응답을 확인하세요.
  • 안전한 자격 증명 관리: 자체 API 키 또는 OAuth 자격 증명을 사용하여 인증하세요.
  • 즉각적인 피드백: API 동작 방식을 실시간으로 파악하고 문제를 해결합니다.

시작하는 방법:

  1. 통합 포털을 방문하세요.
  2. 원하는 제품을 선택하세요( OpenApply , ManageBac , SchoolsBuddy ).
  3. API 문서를 살펴보고 엔드포인트를 선택하세요.
  4. “테스트해 보기” 버튼을 클릭하세요.
  5. 인증 자격 증명을 입력하십시오(설정 방법은 아래를 참조하십시오).
  6. 필수 입력 사항을 입력하고 요청을 제출하세요.
  7. 포털에서 실시간 응답을 직접 확인하세요.

인증 설정:

  • OpenApply v3:
    • OpenApply > 통합 > 공개 API로 이동하세요.
    • 공개 API를 활성화하고 새 OAuth 애플리케이션을 추가하여 클라이언트 ID와 시크릿을 생성하세요.
    • OpenApply v3 API 인증 가이드
  • ManageBac+ v2:
  • SchoolsBuddy :
    • SchoolsBuddy > 설정 > API 관리자 > "추가"를 클릭하세요.
    • 클라이언트 ID와 시크릿을 생성하세요

    • SchoolsBuddy API 인증 가이드

API를 통해 OpenApply 에서 학생 관련 파일을 가져오는 방법

문제: 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 다양한 내보내기 기능도 지원하지만, 프로세스를 자동화하기 위해 API를 활용하여 데이터 워크플로우를 관리하는 방법은 무엇일까요?

해결 방법: 이 문서에서는 OpenApply API( v3 인증 사용)를 이용하여 사용자 정의 필드의 정보를 찾는 방법을 설명합니다. 학생 엔드포인트에는 해당 학생에게 존재하는 모든 사용자 정의 필드와 그 값이 포함됩니다. 또한 검색 엔드포인트를 사용하여 특정 문자열과 일치하는 사용자 정의 값을 가진 학생을 검색할 수 있습니다.

Share

도움이 되었습니까?

10명 중 6명이 도움이 되었다고 했습니다.