통합 및 API
Standard API
시작하기
XChange Advantage Standard API는 고객이 퍼스트 어드밴티지 스크리닝 플랫폼에 원활한 양방향 HTTP/SOAP 통합을 구축할 수 있도록 지원합니다.
지원되는 프로토콜: HTTPS(POST)를 통한 XML 및 HTTPS(웹 서비스) 트랜잭션을 통한 SOAP(심플 오브젝트 액세스 프로토콜).
엑스 체인지 어드밴티지 스탠다드 API(XChange Advantage API) 를 이용하여 당신의 지원서 내에서 다음 서비스들을 통합할 수 있습니다.:
- 스크리닝 프로그램 관리 – 사용자 계정, 비밀번호 및 프로필
- 패키지 내부 검사 – 계정에서 사용할 수 있는 패키지 및 스크리닝 옵션 목록을 가져옵니다
- 스크리닝 주문 – 스크리닝 주문을 시작/업데이트하거나 후보자에게 이메일 초대를 보내 신청을 완료합니다
- 상태/스크리닝 결과 보기 – 주문형 풀 상태 및 실시간 보고서에 대한 URL 링크
- 웹훅 – 사례 상태 알림 및 스크리닝 결과를 URL로 실시간 수신합니다
필요한 것은 우리 시스템의 API 계정뿐입니다(요청 시 이용 가능). 우리 문서는 기업의 개발 플랫폼에서 XChange Advantage Standard API 사용을 시작하기 위해 알아야 할 사항을 안내합니다.
스크리닝 계정 / 사용자 관리
계정 관리 방법
계정 목록 – 스크리닝 프로그램에 구성된 모든 계정/서브 계정을 검색합니다
패키지 내부 검사 – 특정 계정에 대해 구성된 모든 스크리닝 패키지를 검색합니다
사용자 프로비저닝 – 새로운 사용자를 생성, 사용자 업데이트 기능(액세스, 옵션 및 그룹)
사용자 프로필 연결 – 사용자를 프로필에 연결하는 기능(액세스 제어)
스크리닝 주문 모델
XChange Advantage Standard API는 세 가지 스크리닝 주문 모델을 제공합니다:
1단계 스크리닝 주문 모델
1단계 프로세스를 통해 완전 자동화된 시스템 간 인터페이스가 가능합니다. 요청이 접수되면 퍼스트 어드밴티지 시스템이 스크리닝 주문을 생성합니다.
2단계 스크리닝 주문 모델
2단계 프로세스는 XML 서비스를 엔터프라이즈 어드밴티지 웹사이트와 연결합니다. XML 요청은 퍼스트 어드밴티지 주문을 미리 채우는 데 사용됩니다.
후보자 초대 스크리닝 주문 모델
다이렉트 어드밴티지 후보자 플랫폼에서 지원서를 작성하도록 후보자를 초대하세요
스크리닝 상태 및 보고서 보기 방법
링크 가져오기 – 동기식 주문 결과(주문형 풀)는 케이스 상태와 링크 URL을 전체 스크리닝 보고서로 반환합니다. 링크 요청은 한 번만 사용할 수 있습니다.
상태 가져오기 – 동기식 주문 상태(주문형 풀)는 스크리닝 보고서의 상태 및 구성요소를 반환하며 스크리닝 보고서에 대한 URL 링크도 포함합니다.
웹훅
알림 상태
구성 가능한 콘텐츠 변환을 통해 비동기 웹훅 실시간 상태 알림을 제공하고, 알림 콘텐츠(HTML/XML)에 전체 상세 보고서 결과를 활성화하며, 이메일 상태 알림도 사용할 수 있습니다
오류
코드 | 설명 |
---|---|
100 | 유효하지 않은 XML |
200 | 유효하지 않은 로그인 |
210 | 사용자가 잠겼습니다 |
220 | 비밀번호가 만료되었습니다 |
240 | 계정 또는 사용자가 비활성화되었습니다 |
250 | 유효하지 않은 주문 계정 |
300 | 유효하지 않은 패키지 |
320 | 필수 값이 누락되었습니다 |
500 | 요청 오류(예기치 않은 오류에 대한 “포괄적” 오류입니다.) |