Motimate: 공개 API를 사용하여 보고서를 생성하는 방법

다음을 통해 코스 완료 데이터를 공유하는 것 외에도 모티메이트 xAPI를 통해 코스 완료 데이터를 공유할 수 있을 뿐만 아니라, 모티메이트 퍼블릭 API에서 엑셀 파일 추출도 지원합니다. 이러한 Excel 보고서는 이전에 생성한 보고서 템플릿을 기반으로 합니다. 보고서 생성 기능에서 이전에 생성한 보고서 템플릿을 기반으로 합니다.

시작하기 전에 몇 가지 유용한 정보를 알려드립니다:

세 가지 관련 모티메이트 퍼블릭 API 기능은 다음과 같습니다:

• GET /인사이트/학습/보고서_템플릿
   
• POST /인사이트/학습/보고서_요청
   
• GET /인사이트/학습/보고서_요청/{id}

공개 API로 보고서를 생성하기 전에 보고서 템플릿이 이미 보고서 생성하기(여기 가이드 참조)에서 생성되었는지, 어떤 템플릿으로 보고서를 생성할지 알고 있는지 확인하세요. 이 준비가 완료되면 보고서를 생성하는 프로세스에는 세 단계가 필요합니다:

1단계: 보고서 템플릿 목록을 가져옵니다:

명령: GET /insights/학습/보고서_템플릿

응답 예시:

{
  "데이터": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe"**,
      "name": "리포트 테스트",
      "설명": "퍼블릭 API 목적의 테스트",
      "last_status": "업로드 중",
      "last_generated_at": null,
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-01T15:41:26.98349+01:00",
      "user": {
        "name": "John Doe"
      }
    }
  ]
}

다음 단계에서 사용할 템플릿 ID를 기록해 두세요(이 경우: abc86b82-029a-4b74-9690-4ab607f3eafe).

2단계: 선택한 템플릿을 기반으로 새 보고서 생성하기

Command: POST /insights/learnings/report_requests

이 예제에서는 이 요청에 abc86b82-029a-4b74-9690-4ab607f3eafe를 template_id로 제출해야 합니다.

응답 예시:

{
  "데이터": {
    **"id": "abc23922-940d-4d6d-a6f0-ecaed00810c4"**,
    "status": "started",
    "created_at": "2022-03-03T08:48:46.051Z",
    "updated_at": "2022-03-03T08:48:46.051Z",
    "url": null,
    "template": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "리포트 테스트",
      "설명": "퍼블릭 API 목적 테스트",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

URL의 값은 아직 사용할 수 없습니다. 보고서에 포함되는 데이터의 양에 따라 보고서를 생성하는 데 몇 분 정도 걸릴 수 있습니다. 다음 단계에서 보고서의 URL을 요청하게 됩니다.

3단계: Excel 보고서 파일의 URL 가져오기

명령: GET /insights/학습/보고서_요청/{id}

템플릿용 ID가 아닌 2단계의 응답에 데이터용 ID를 사용해야 합니다!

응답 예시:

{
  "data": {
    "id": "abc23922-940d-4d6d-a6f0-ecaed00810c4",
    "status": "done",
    "created_at": "2022-03-03T08:48:46.051Z",
    "updated_at": "2022-03-03T08:48:46.839Z",
    **"url": "<https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de>"**,
    "template": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "리포트 테스트",
      "설명": "퍼블릭 API 목적의 테스트",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

URL 값이 포함된 응답을 받을 때까지 30초마다 이 요청을 반복적으로 실행해야 할 수도 있습니다. 보고서를 생성하는 데 필요한 데이터의 양에 따라 소요 시간이 달라집니다.

이 예에서 URL은 https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de

이 URL에 액세스하면 .xlxs Excel 파일로 보고서를 다운로드할 수 있습니다. 현재 .csv와 같은 다른 파일 형식의 데이터는 추출할 수 없습니다.

참고: 파일은 10분 후에 만료되므로 그 전에 다운로드해야 합니다.

ℹ️ 선택한 그룹 및 사용자의 데이터에 대한 액세스 권한만 있는 그룹 관리자가 보고서 템플릿을 만든 경우, 이 제한은 모티밋 공개 API를 사용할 때에도 여전히 적용됩니다.