학교들은 학생, 교직원, 활동 관리를 위해 점점 더 많은 시스템을 사용하고 있으며, 이러한 데이터의 동기화를 유지하려면 과거에는 수동 재입력이나 맞춤형 해결책을 사용해야 했습니다. SchoolsBuddy 공개 API는 이러한 문제를 해결하여 학교가 이미 사용 중인 도구와 SchoolsBuddy 안전하고 직접적으로 연결할 수 있는 방법을 제공합니다.

핵심 사용자 및 활동 관리를 중심으로 구축된 이 API는 개발 팀에게 SchoolsBuddy 와 프로그래밍 방식으로 상호 작용할 수 있는 확장 가능하고 유연한 방법을 제공하며, 조직의 최고 관리자가 접근 권한을 엄격하게 제어하여 모든 통합을 안전하게 유지합니다.

개요

SchoolsBuddy 공개 API는 수동 데이터 입력을 줄이고 학교 시스템 전반에 걸쳐 데이터를 동기화하도록 설계되었습니다. 이 API는 대량 관리 작업을 자동화하거나 SchoolsBuddy 맞춤형 또는 자체 개발한 MIS/SIS 플랫폼과 통합해야 하는 기술팀, 특히 조직의 최고 관리자와 개발자를 위해 만들어졌습니다.

새로운 소식

API에는 학생, 연락처, 직원, 이벤트, 위치, 그룹, 선호도 및 즉시 예약 가입을 포함한 핵심 데이터 엔티티에 대한 엔드포인트가 포함되어 있습니다. 주요 기능은 다음과 같습니다.

• 위치 관리: 모든 학교 활동에 사용할 특정 위치를 생성하고 관리합니다.
• 데이터 내보내기: SchoolsBuddy 활동을 학생 또는 이벤트별로 내보내어 다른 내부 시스템과 원활하게 연동하고 표시할 수 있습니다.
• 출석 API: 프로그램 방식으로 이벤트 출석 기록을 읽고 써서 학교 시스템 전체를 실시간으로 동기화할 수 있습니다.
• 외부 학생 등록: 입학 예정자, 여름학교 참가자 또는 외부 특별활동 참가자 등 학교 학생 정보 시스템(SIS)에 등록되지 않은 학생을 추가하고 관리합니다.
• 직원 및 진행자 기록: SIS에 등록되지 않은 외부 인력(초청 진행자, 외부 코치, 여행 인솔자, 교육청 직원 등)을 관리합니다.
• 가상 환경 통합: 학교에서 선택한 디지털 커뮤니케이션 플랫폼에서 교사의 온라인 회의 ID를 업데이트하고 관리합니다.
• 생성 및 관리: 선호도 및 즉시 예약 등록, 스포츠 또는 여행 행사 일정 관리를 위한 그룹, 수수료 부과를 위한 그룹, 학부모-교사 면담을 위한 과목별 그룹(다른 데이터 가져오기 소스가 없는 경우에만 필요).

단계별 탐색

API 클라이언트 설정하기

관리자 설정 > 통합 > 공개 API

1. API 접근 권한을 부여하려면 조직 최고 관리자 권한이 필요하므로, 해당 권한으로 로그인했는지 확인하십시오.
2. API 클라이언트를 등록하고 자격 증명을 생성하려면 전용 설정 가이드를 따르십시오.
3. 제공된 자격 증명을 사용하여 통합을 위한 OAuth 2.0 인증을 구성하십시오.
4. 첫 번째 호출을 구축하기 전에 Swagger 문서에서 사용 가능한 엔드포인트(학생, 연락처, 직원, 이벤트, 위치, 그룹, 가입)를 검토하십시오.
5. 가능하다면 실제 데이터 동기화를 배포하기 전에 비프로덕션 데이터 세트를 사용하여 통합 기능을 테스트하십시오.

자세한 설정 방법은 여기에서 확인할 수 있습니다: SchoolsBuddy 공개 API 설정 방법 .

팁 및 모범 사례

• 보안 최우선: 제공된 OAuth 2.0 인증 표준을 사용하여 데이터에 대한 안전한 액세스를 보장하십시오.
• 문서 검토: 개발자는 전체 엔드포인트 사양 및 인증 지침을 확인하려면 통합 포털 과 Swagger 페이지를 참조해야 합니다.
• 효율성: 대규모 데이터 세트를 처리할 때 효율적인 데이터 검색을 위해 페이지네이션 메타데이터를 활용합니다.

경고 및 중요 사항

관련 기사

• SchoolsBuddy 공개 API 설정 방법
• 조직 관리 최고 관리자 권한

자주 묻는 질문

어떤 인증 방식이 사용되나요?

이 API는 모든 통합에 대한 최신 보안 표준을 보장하기 위해 OAuth 2.0 인증을 사용합니다.

기술 문서가 있습니까?

예, OpenAPI/Swagger 정의를 포함한 포괄적인 개발자 문서는 통합 포털을 통해 이용할 수 있습니다.

누가 API 접근 권한을 설정할 수 있나요?

조직의 최고 관리자만 API 클라이언트 액세스 권한을 부여할 수 있으므로 통합 보안이 엄격하게 관리됩니다.

요약하자면

• API는 SchoolsBuddy 내부 또는 타사 시스템과 연결하여 데이터 워크플로를 자동화합니다.
• 현재 학생, 교직원, 행사, 장소, 그룹, 선호도 및 즉시 예약 가입 기능을 제공합니다.
• 접근 권한은 조직의 최고 관리자만 OAuth 2.0을 통해 부여할 수 있습니다.

SchoolsBuddy 공개 API를 활용하여 학교 운영 효율성을 높이세요.