개념: Peakon API
Peakon API를 사용하여 Peakon에서 참여 데이터를 검색합니다. 액세스 토큰으로 인증한 다음, 참여 점수 및 주요 메트릭에 액세스하기 위해 엔드포인트에 대한 GET 요청을 수행합니다.
인증
커스텀 어플리케이션이 생성되면 생성된 액세스 토큰이 표시됩니다. 이 토큰은 어플리케이션에 고유한 비밀 토큰입니다. /v1/auth/application 엔드포인트를 사용하여 POST 요청을 수행하여 액세스 토큰을 인증 토큰으로 교환합니다.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
성공한 인증 요청의 응답 본문에는 모든 후속 API 요청에 사용되는 JWT 인증 토큰이 포함됩니다. 어플리케이션에 둘 이상의 인증 토큰이 있을 수 있는 경우에도 어플리케이션별로 비율 한도가 적용됩니다.
JWT를 얻기 위해 액세스 토큰으로 인증한 후에는 이를 사용하여 참여 점수 및 기타 주요 메트릭에 액세스하기 위해 엔드포인트에 대한 GET 요청을 수행할 수 있습니다. 방문 단계: REST API를 사용하여 커스텀 앱 빌드설정 방법에 대한 자세한 내용은 을 참조하십시오.
필터링
상황별 경로 외에도 필터 쿼리 매개변수를 통해 여러 경로에 대한 추가 필터링이 지원됩니다. 라우팅이 필터링을 지원하는 경우 아래 라우팅 사양에 쿼리 매개변수로 나열됩니다. 필터는 논리적 모델을 기준으로 구성됩니다. 질문 요인을 기준으로 필터링하려면 필터 접두어
question
. 예를 들어 다음과 같습니다.GET /v1/engagement/drivers?filter[question.driver]=autonomy
매칭 필드에 여러 연산자가 지원됩니다. 예: 자율성 및 보상 요인에 대한 점수만 가져오려면 다음 필터를 제공합니다.
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
지원되는 필터링 연산자 목록은 다음을 참조하십시오. 참조: Peakon API 필터링 값.
JSON 형식
모든 오브젝트는 JSON을 사용하여 오브젝트 그래프를 모델링하는 방법인 JSON API를 사용하여 렌더링됩니다.
라우팅
일부 요청은 회사의 임의 세그먼트로 제한될 수 있습니다. 지정된 매니저의 모든 직속직원 또는 지정된 부서의 eNPS에 대한 참여 데이터를 분석하려고 할 수 있습니다.
예: 영업 부서의 세그먼트 ID는 149입니다. 다음 요청을 통해 이 부서의 참여 개요를 확인할 수 있습니다.
GET v1/engagement/context/149/overview
세그먼트 ID를 가져오려면 컨텍스트 전환기를 사용하여 회사에서 세그먼트 자체로 컨텍스트를 변경합니다. 컨텍스트 전환기는 페이지의 왼쪽 상단에 있습니다. 세그먼트명을 검색하고 선택하여 액세스합니다. 세그먼트 ID는 URL에서 다음과 같이 표시됩니다.
segment/
매개변수 컨텍스트 전환기에 대한 자세한 내용은 다음을 참조하십시오. 개념: 대시보드 컨텍스트.비율 제한
Peakon은 다중 테넌트 서비스입니다. 개별 고객이 과도한 양의 리소스를 사용하는 것을 방지하기 위해 비율 한도가 설정되어 있습니다. 등록된 각 어플리케이션에는 기본적으로 다음과 같은 비율 한도가 적용됩니다.
- 시간당 최대 5000건의 요청
- 실제 시간 기준 5분당 최대 12분의 처리 시간
어플리케이션이 두 제한 중 하나를 초과하면 API가 다음을 반환합니다.
429 Too Many Requests
응답 기본 비율 한도는 정기적으로 리뷰되고 업데이트됩니다.