이 가이드에서는 SchoolsBuddy 에서 API 액세스를 설정하고 관리하는 방법을 설명합니다. 이 과정을 통해 기술팀은 OAuth 2.0을 통해 인증하고 외부 시스템을 SchoolsBuddy 에 연결할 수 있습니다.

이러한 설정에 접근하려면 특정 권한이 필요합니다. 진행하기 전에 조직 최고 관리자 계정으로 로그인했는지 확인하십시오.

개요

공용 API 관리자 영역은 조직의 최고 관리자가 관리할 수 있는 공간입니다. 이 중앙 허브에서 학교 데이터 통합에 사용되는 클라이언트를 생성, 편집 및 보호할 수 있습니다.

핵심 개념

설치를 시작하기 전에 다음 필수 조건이 충족되었는지 확인하십시오.

• 현재 조직 최고 관리자 로 로그인되어 있습니다.
• 필요한 권한 및 범위를 설정하는 데 필요한 기술 문서를 준비하셨습니다.

단계별 탐색

팁 및 모범 사례

• 스테이징 환경: 가능한 경우, 실제 SchoolsBuddy 인스턴스에 연결하기 전에 항상 스테이징 환경에서 통합 기능을 테스트하십시오.
• 대량 작업: 데이터 무결성을 보장하기 위해 대량 쓰기 작업을 시작하기 전에 기술 문서를 꼼꼼히 검토하십시오.
• 자격 증명 관리: API 관리자 내에서 권한을 편집하거나, 자격 증명을 다시 생성하거나, 클라이언트를 비활성화/삭제하여 보안을 유지할 수 있습니다.

경고 및 중요 사항

보안 접근 권한: API 자격 증명은 학교 데이터에 대한 상당한 접근 권한을 제공합니다. 승인된 담당자만 최고 관리자 권한으로 이러한 설정을 관리할 수 있도록 하십시오.

공개 공유 금지: 클라이언트 시크릿은 절대 공개적으로 공유하지 마십시오. 이 자격 증명은 SchoolsBuddy 인스턴스와 고유하게 연결되어 있으며 데이터 생태계에 직접 액세스할 수 있도록 해줍니다.

관련 기사

• SchoolsBuddy 공개 API 소개

자주 묻는 질문

클라이언트 시크릿을 분실하면 어떻게 되나요?

보안상의 이유로 SchoolsBuddy 클라이언트 암호를 다시 표시하지 않습니다. 해당 클라이언트에 대한 자격 증명을 다시 생성 하려면 API 관리자를 사용해야 합니다.

API의 기능을 제한할 수 있나요?

예. 구성 과정에서 특정 통합에 필요한 읽기(GET) 또는 쓰기(POST/PUT) 액세스 권한만 부여하도록 특정 권한 및 범위를 정의할 수 있습니다.

요약하자면

• 설정의 API 관리자를 통해 API 관리자에 액세스하세요.
• 특정 범위를 가진 새 클라이언트를 생성하여 자격 증명을 생성합니다.
• 클라이언트 ID와 비밀 키는 안전하게 보관하고 절대 공개적으로 공유하지 마십시오.

SchoolsBuddy 연동이 완료되어 이제 데이터 동기화를 시작할 수 있습니다.