ManageBac+ 공개 API를 사용하면 학교는 ManageBac+ 계정을 ManageBac+ 와 직접 통합되지 않은 외부 플랫폼에 연결할 수 있습니다.

학교 계정 관리자만 이러한 설정을 구성할 수 있습니다. 이 가이드에서는 설정, 토큰 관리, 지원 기능, 기술 참고 사항, 권한 및 자주 묻는 질문을 다룹니다.

개요

ManageBac+ 공개 API는 타사 시스템과의 맞춤형 연결을 구축해야 하는 학교를 위해 설계되었습니다. API 접근은 관리자가 생성하고 관리하는 토큰을 통해 제어됩니다.

API 관리자를 통해 토큰을 생성하고, 권한을 제어하고, 토큰 상태를 검토하고, 참조 문서를 확인하고, API 변경 로그를 볼 수 있습니다.

핵심 개념 / 새로운 소식

지원되는 필드 및 함수

왼쪽 메뉴에서 '참조 문서' 탭을 열면 API 연결 설정에 대한 자세한 안내를 확인할 수 있습니다. 여기에는 샘플 요청 및 응답에 대한 설명도 포함되어 있습니다. 또한 이 페이지 상단에는 버전 드롭다운 메뉴가 있어 다양한 API 버전에 사용할 수 있는 요청을 선택할 수 있습니다.

API 권한

권한 필드의 경우 '없음'을 선택하거나, 읽기 전용 권한만 있는 필드만 선택하거나, '모두' 를 선택할 수 있습니다. 또한 체크박스를 선택하여 개별 필드를 선택할 수도 있습니다.

재학생

• 색인
• 보여주다
• 만들다
• 업데이트
• 보관소
• 아카이브 해제

부모

• 색인
• 보여주다
• 만들다
• 업데이트
• 보관소
• 아카이브 해제

선생님들

• 색인
• 보여주다
• 만들다
• 업데이트

학년 그룹

• 색인
• 자문가
• 재학생
• 학생 추가
• 학생들을 제거하세요
• 학기 출석
• 날짜-출석

수업

• 색인
• 보여주다
• 재학생
• 학생 추가
• 학생들을 제거하세요
• 학기 출석
• 날짜-출석

수업 평가

• 학기별 성적

멤버십

• 색인

학교

• 보여주다
• 학년도
• 주제
• 성적

과제

• 인덱스는 학생들을 보여줍니다

API 함수

학년 그룹

• 모든 학년을 확인하세요
• 조언자를 구하세요
• 한 학년 전체 학생들을 모집합니다.
• 학년에 학생 추가하기
• 학년에서 학생들을 제외시키세요
• 학년 및 학기별 담임반 출석 현황을 확인하세요.
• 지정된 날짜의 특정 학년 담임반 출석 현황을 확인하세요.

수업

• 모든 수업을 받으세요
• 수업을 들어보세요
• 수업 수강생 모집하기
• 수업에 학생 추가하기
• 학생들을 수업에서 제외시키세요
• 수업 과제 받기
• 수업 과제 받기
• 과제 및 수업에 대한 학생 평가 결과를 확인하세요
• 수업의 학기 성적을 확인하세요
• 한 학기 동안 수강한 모든 과목의 성적을 확인하세요.
• 학기 중 수업 출석 확인
• 데이트 상대의 수업 출석을 확인하세요

멤버십

• 모든 멤버십을 받으세요

재학생

• 모든 학생들을 받으세요
• 학생을 구하세요
• 새 학생 생성
• 학생 정보 업데이트
• 학생 기록 보관
• 학생의 아카이브를 해제하세요

선생님들

• 모든 선생님들을 만나보세요
• 선생님을 구하세요
• 새로운 교사 생성
• 교사 정보 업데이트

부모

• 모든 부모님을 모으세요
• 부모님을 구하세요
• 새로운 부모 생성
• 부모 정보 업데이트
• 부모를 보관하세요
• 부모의 보관 해제

학교

• 학교 정보 확인하기
• 학년도를 확인하세요
• 학교 성적을 확인하세요
• 학교 과목을 알아보세요

유용

• 핑
• 아바타를 받으세요

API 변경 로그

ManageBac+ 에서 API 변경 로그를 보려면 설정 > 개발 > API 관리자 로 이동하세요. 이 페이지 하단의 변경 로그 섹션에서 최근 API 업데이트(새 필드, 추가 또는 수정된 엔드포인트, 기타 관련 기술 변경 사항 포함)가 시간순으로 나열된 것을 확인할 수 있습니다.

단계별 탐색

ManageBac+ 공개 API를 활성화하고 토큰을 추가하세요.

1. 설정 > 개발 > API 관리자 > 새 토큰 추가 로 이동합니다.
2. '새 토큰 추가'를 클릭하세요.
3. 토큰의 용도를 쉽게 파악할 수 있도록 명확하고 유용한 토큰 이름을 입력하세요.
4. 학생, 학부모, 교사 데이터, IB 그룹, 수업 및 학교 설정 등 업데이트 및 조회할 항목을 선택하세요.
5. 토큰을 생성하려면 '토큰 추가'를 클릭하세요.

API 토큰을 수정하거나 관리하세요

1. 설정 > 개발 > API 관리자를 엽니다.
2. 클립보드 아이콘을 사용하여 토큰을 복사하고 다른 신뢰할 수 있는 시스템에서 사용하세요.
3. i 아이콘 위에 마우스를 올리면 토큰 권한을 볼 수 있습니다.
4. 토큰 상태를 검토하여 활성화되었는지 비활성화되었는지 확인하십시오.
5. 편집을 클릭하여 권한을 조정하거나 토큰을 비활성화 또는 활성화할 수 있습니다.
6. 연동이 더 이상 필요하지 않으면 휴지통 아이콘을 사용하여 토큰을 삭제하세요.

경고 및 중요 사항

보안 경고

API 토큰은 신뢰할 수 있는 관계자에게만 공유해야 합니다. API 토큰은 SSL 암호화 없이 이메일로 전송하거나 양식에 저장해서는 안 됩니다. 연동 기능을 더 이상 사용하지 않을 경우, 삭제 아이콘을 클릭하여 API 토큰을 비활성화하는 것이 좋습니다.

자주 묻는 질문

ManageBac+ 다른 플랫폼과 연동되나요?

설정 > 통합 > 파트너 목록에 제품이 표시되지 않으면 공식적인 제휴 관계가 없는 것입니다. 이러한 경우에도 학교에서는 공개 API를 사용하여 사용자 지정 통합을 설정할 수 있습니다.

ManageBac+ 지원팀에서 저희 학교를 위한 통합 기능을 구축해 줄 수 있나요?

ManageBac+ 와 연동하고 싶은 시스템이 있다면 알려주세요. 해당 도구 또는 서비스와 직접적인 파트너십을 맺는 것이 당사 및 제품 측면에서 타당한지 검토해 보겠습니다.

ManageBac+ 지원팀에서 저희를 대신하여 API 요청을 작성해 줄 수 있나요?

ManageBac+ 지원팀은 API 관련 질문 및 문제에 대한 안내를 제공할 수 있지만, 모든 API 요청은 학교에서 직접 처리해야 합니다. 사용자 지정 연결을 설정하려면 IT 부서에 문의하십시오.

ManageBac+ API 사용량 제한은 얼마인가요?

API 요청 제한은 동일 IP 주소에서 분당 200건 입니다.

ManageBac+ 공개 API 사용 방법에 대한 안내는 어디에서 찾을 수 있나요?

각 필드에 대한 자세한 내용과 최신 변경 로그는 설정 > 개발 > 참조 문서를 참조하십시오.

API 요청에 문제가 발생했습니다. 누구에게 문의해야 하나요?

요청 내용과 발생한 오류에 대한 자세한 정보를 api@managebac.com 으로 이메일로 보내주시기 바랍니다.

요약하자면

• ManageBac+ 공개 API를 통해 학교는 관리자가 관리하는 토큰을 사용하여 ManageBac+ 외부 시스템과 연결할 수 있습니다.
• 설정 > 개발 > API 관리자 에서 토큰을 생성, 검토, 편집, 비활성화 및 삭제할 수 있습니다.
• 참조 문서, 권한, API 노트, 변경 로그 세부 정보 및 일반적인 지원 지침은 모두 API 관리자 워크플로 내에서 확인할 수 있습니다.

ManageBac+ 학교가 API 접근을 안전하고 권한 기반으로 유지하면서 맞춤형 통합 기능을 구축할 수 있는 체계적인 방법을 제공합니다.