ManageBac+ Public API를 사용하여 다른 시스템을 연결하세요. API 토큰을 생성 및 관리하고 지원되는 필드와 권한을 찾으세요.
ManageBac+ 공개 API 작동 방법, API 토큰 생성 및 관리 방법, 지원되는 필드, 기능, 권한, 메모 및 변경 로그 정보를 찾을 수 있는 위치에 대해 알아보세요.
ManageBac+ 공개 API를 사용하면 학교에서 ManageBac+ 계정을 ManageBac+ 와 직접 통합되지 않은 외부 플랫폼에 연결할 수 있습니다.
학교 계정의 관리자만 이러한 설정을 구성할 수 있습니다. 이 가이드에서는 설정, 토큰 관리, 지원 기능, 기술 노트, 권한 및 자주 묻는 질문(FAQ)을 다룹니다.
개요
ManageBac+ 공개 API는 타사 시스템과의 맞춤형 연결을 구축해야 하는 학교를 위해 설계되었습니다. API 액세스는 관리자가 생성하고 관리하는 토큰을 통해 제어됩니다.
API Manager에서 토큰을 생성하고, 권한을 제어하고, 토큰 상태를 검토하고, 참조 문서에 액세스하고, API 변경 로그를 볼 수 있습니다.
설정 > 개발에는 이제 두 개의 API 관리자가 있습니다. API Manager (Legacy) 이 가이드에 설명된 API 토큰을 생성합니다. API Manager (OAuth2) OAuth2 자격 증명을 발급합니다. 연결하려는 시스템이 지원하는 시스템을 사용하십시오.
주요 개념/새로운 소식
지원되는 필드 및 기능
샘플 요청 및 응답이 포함된 메모를 포함하여 API 연결 설정에 대한 자세한 지침을 보려면 왼쪽 메뉴에서 참조 문서 탭을 엽니다. 이 페이지 상단에는 버전 드롭다운도 포함되어 있어 다양한 API 버전에 대해 나열된 사용 가능한 요청을 사용할 수 있습니다.
API 권한
권한 필드의 경우 없음 을 선택하거나, 읽기 전용 권한이 있는 항목만 선택하거나, 모두 를 선택할 수 있습니다. 확인란을 선택하여 개별 필드를 선택할 수도 있습니다.
재학생
- 색인
- 보여주다
- 만들다
- 업데이트
- 보관소
- 보관 취소
부모
- 색인
- 보여주다
- 만들다
- 업데이트
- 보관소
- 보관 취소
교사
- 색인
- 보여주다
- 만들다
- 업데이트
연도 그룹
- 색인
- 고문
- 재학생
- 학생 추가
- 제거-학생
- 학기 출석
- 날짜 출석
수업
- 색인
- 보여주다
- 재학생
- 학생 추가
- 제거-학생
- 학기 출석
- 날짜 출석
수업 평가
- 학년학기 성적
멤버십
- 색인
학교
- 보여주다
- 학년
- 과목
- 성적
작업
- 색인쇼학생
API 기능
연도 그룹
- 모든 연도 그룹 가져오기
- 조언자 받기
- 한 학년 그룹의 학생 구하기
- 학년 그룹에 학생 추가
- 학년 그룹에서 학생 제거
- 학년 및 학기 동안 홈룸 출석을 얻습니다.
- 지정된 날짜에 학년 그룹의 홈룸 출석을 얻습니다.
수업
- 모든 수업 받기
- 수업 받기
- 수업을 위해 학생 모집
- 수업에 학생 추가
- 수업에서 학생 제거
- 수업에 대한 과제 가져오기
- 수업에 대한 과제 가져오기
- 과제 및 수업에 대한 학생 평가 결과 받기
- 수업의 학기 성적 받기
- 학기 중 해당 과목의 모든 성적 취득
- 학기 중 수업 출석 확인
- 특정 날짜에 대한 수업 출석 확인
멤버십
- 모든 멤버십 받기
재학생
- 모든 학생 가져오기
- 학생 구하기
- 새 학생 만들기
- 학생 업데이트
- 학생 보관
- 학생 보관 취소
교사
- 모든 선생님을 구하세요
- 선생님을 구하세요
- 새 교사 만들기
- 교사 업데이트
부모
- 모든 상위 항목 가져오기
- 부모를 구하세요
- 새 상위 생성
- 상위 업데이트
- 상위 항목 보관
- 상위 항목 보관 취소
학교
- 학교 세부정보 가져오기
- 학년 구하기
- 학교 성적 받기
- 학교 과목 받기
유용
- 핑
- 아바타 받기
API 변경 로그
설정 > 개발 > API Manager (Legacy) 로 이동하여 ManageBac+ 에서 API 변경 로그를 볼 수 있습니다. 이 페이지 하단에는 새로운 필드, 추가 또는 수정된 엔드포인트, 기타 관련 기술 변경 사항을 포함하여 최근 API 업데이트가 시간순으로 나열되는 변경 로그 섹션이 있습니다.
단계별 탐색
ManageBac+ 공개 API를 활성화하고 토큰을 추가하세요.
- 설정 > 개발 > API Manager (Legacy) > 새 토큰 추가 로 이동합니다.
- 새 토큰 추가 를 클릭합니다.
- 명확하고 유용한 토큰 이름을 입력하면 토큰이 어떤 용도로 사용되는지 쉽게 식별할 수 있습니다.
- 학생, 학부모 및 교사 데이터, IB 그룹, 수업 및 학교 설정을 포함하여 업데이트하고 검색하려는 포인트를 선택하십시오.
- 토큰 추가를 클릭하여 토큰을 생성합니다.
API 토큰 편집 또는 관리
- 설정 > 개발 > API Manager (Legacy) 엽니다.
- 다른 신뢰할 수 있는 시스템에서 사용할 토큰을 복사하려면 클립보드 아이콘을 사용하세요.
- i 아이콘 위로 마우스를 가져가면 토큰 권한을 볼 수 있습니다.
- 토큰 상태를 검토하여 활성화 또는 비활성화되었는지 확인하세요.
- 편집을 클릭하여 권한을 조정하거나 토큰을 비활성화 또는 활성화합니다.
- 통합이 더 이상 필요하지 않은 경우 쓰레기통 아이콘을 사용하여 토큰을 삭제하세요.
경고 및 중요 참고 사항
보안 경고
귀하의 API 토큰은 신뢰할 수 있는 당사자와만 공유되어야 합니다. API 토큰은 SSL 암호화 없이 이메일로 전송하거나 양식에 저장해서는 안 됩니다. 통합이 더 이상 사용되지 않으면 삭제 아이콘을 클릭하여 API 토큰을 비활성화하는 것이 좋습니다.
API 노트
- Null 값은 렌더링되지 않습니다.
- POST 요청에서는 Null 값이 무시됩니다.
- 빈 문자열 값은 무시되지 않으며 기존 값을 덮어씁니다.
- 대량 할당을 위한 사용자를 찾을 수 없으면 모든 호출에서 오류가 반환됩니다(예: parent_ids 또는 child_ids).
- AND 논리를 사용하여 인덱스 작업 스택에 사용할 수 있는 매개변수입니다. 수정된_since 와 삭제된_since를 동시에 사용하면 삭제 시 레코드 수정 타임스탬프가 변경되지 않으므로 예상한 결과가 반환되지 않을 수 있습니다.
- 관리자 역할이 있는 모든 사용자는 보안상의 이유로 API를 통해 읽기 전용입니다.
- 모든 타임스탬프 필드는 ISO8601 형식입니다(예: yyyy-mm-ddThh:mm:ss.sssTZ (예: 2017-11-06T04:35:00.000GST )).
- API에 대한 질문이나 우려 사항이 있는 경우 api@managebac.com으로 문의하세요.
비율 제한
API 요청 제한은 동일한 IP 주소에서 분당 200개의 요청 입니다.
자주 묻는 질문
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 Manager (Legacy) 에서 토큰을 생성, 검토, 편집, 비활성화 및 삭제할 수 있습니다.
- 참조 문서, 권한, API 노트, 변경 로그 세부 정보 및 일반적인 지원 지침은 모두 API Manager 워크플로 내에서 사용할 수 있습니다.
ManageBac+ API 액세스를 권한 기반으로 안전하게 유지하면서 맞춤형 통합을 구축할 수 있는 통제된 방법을 학교에 제공합니다.