所容纳之物
SkyPrep API允许您获取内容。
欢迎使用SkyPrep API。该API允许您在SkyPrep中执行最常见的操作。这包括用户、组、课程和注册的创建、读取、更新和删除操作。
API是一个简单的HTTP GET/POST接口,使用查询字符串参数(例如请求可以看起来像https://api.skyprep.io/admin/api/create_user?api_key=12345
)或POST主体参数。它围绕易用性进行设计,并且在许多编程和脚本语言中使用起来相当简单。
&用户电子邮件=sampleuser@www.jeanhegland.com&第一个名字=詹姆斯。。。。
注意:强烈建议使用HTTP POST方法发出所有API请求,因为这将防止API密钥意外地显示在服务器日志/浏览器历史记录中。
默认情况下,所有响应都以JSON格式返回总体安排
等于xml
的请求。
API的RESTful版本将在不久的将来提供。
我们建议使用邮递员客户使用API进行测试,以了解数据是如何返回的。
如果您只是在Google Chrome浏览器中测试API,还应该安装JSONView它将格式化并正确地反转义json格式的文本。
所有API请求均发送至https://api.skyprep.io/admin/api
任何问题都可以发送到api@www.jeanhegland.com
API需要帐户的API密钥(api_密钥
)和SkyPrep域(会计键
)作为每个请求的一部分提供,以及您平台的域(不带任何HTTP或HTTPS前缀)。API密钥可在平台的“自定义”选项卡中找到。所有请求必须包括api_密钥
.
**一定要保持api_密钥
私有且安全。不要公开API密钥**
在不久的将来,一个使用签名参数(HMAC/SHA2)进行身份验证的API版本(不包括作为请求负载一部分的API密钥)将可用,以允许在面向公众/非服务器端链接中嵌入API调用。
获取https://api.skyprep.io/admin/api/test_connection #sample parameters {"api_key": "Your API Key", //Required "acct_key": "yourskyprepdomain.skyprepapp.com" //Required} #sample response {"message": "success"}
SkyPrep API允许添加、更新和删除用户。
获取系统中的所有用户。
返回一个JSON数组。
收到https://api.skyprep.io/admin/api/get_users
收到https://api.skyprep.io/admin/api/get_users #样本响应[{“id”:32,“名字”:“John”,“姓氏”:“Doe”,“用户名”:“John”。doe@www.jeanhegland.com“,”卡片编号“:”Emp.#3211221“,”创建时间“:”2013年6月23日12:00:00”//更多JSON数据“,”{“id”:44,“名字“:”詹姆斯“,”姓氏“:”迪尔“,”用户名“:”詹姆斯。deere@www.jeanhegland.com", “卡号”:“Emp.#1472546”,“创建时间”:“2013年6月28日12:00:00”//More JSON data},…]
可以使用API检索用户数据。
收到https://api.skyprep.io/admin/api/get_user
得到https://api.skyprep.io/admin/api/get_user样本参数{“user_id”:内部SkyPrep user_id(独特的)/ /或“user_email”:“用户电子邮件”}#示例响应{" id ": 32岁的“first_name”:“约翰”,“last_name”:“母鹿”、“用户名”:“john.doe@www.jeanhegland.com”,“card_no”:“Emp。# 3211221”/ / JSON数据}
通过传入这些参数,可以通过API创建用户(学习者、管理员、经理)
邮递https://api.skyprep.io/admin/api/create_user
文章https://api.skyprep.io/admin/api/create_user样本参数{“电子邮件”:“james.doakes@www.jeanhegland.com”“first_name”:“詹姆斯”,“last_name”:“Doakes”,“角色”:“经理”,“标题”:“侦探”,“细胞”:“818-333-3333”,“work_phone”:“818-444-4444”、“地址”:“十德克斯特开迈阿密FL”“card_no”:“徽章编号158 - 612”,“ca_0”:“别名:Bay Harbour Butcher"} #示例响应{"id": 21, "first_name": "James", "last_name": "Doakes", "username": "james.doakes@www.jeanhegland.com", "card_no": "Badge No 158-612", "role": "manager" //其他用户数据}
用户(学习者、管理员、管理者)可以通过API传递这些参数进行更新。如果参数是ommited,则不会更新这些参数。
文章https://api.skyprep.io/admin/api/update_user
注:参数同创造
以上
邮递https://api.skyprep.io/admin/api/update_user #示例参数{“user_email”:“james”。doakes@www.jeanhegland.com“名字”:“詹姆斯”,“姓氏”:“道克斯”,“角色”:“管理员”,“头衔”:“侦探”,“手机”:“818-333-3333”,“工作电话”:“818-444-4444”,“地址”:“佛罗里达州迈阿密德克斯特大道10号”“卡号”:“徽章号158-612”,“卡号0”:别名:Bay Harbor Butcher,“访问开始日期”:“2015年7月31日”,“访问结束日期”:“2017年7月30日”}样本响应{“id”:21,“名字”:“James”,“姓氏”:“Doakes”,“用户名”:“James”。doakes@www.jeanhegland.com“,”卡号“:”卡号158-612“,//其他用户数据}”
从系统中永久删除用户。
文章https://api.skyprep.io/admin/api/destroy_user
邮递https://api.skyprep.io/admin/api/destroy_user #示例参数{“user_email”:“james。doakes@www.jeanhegland.com“}#示例响应{“消息”:“成功”}
获取用户的自动登录URL(通过电子邮件)
获取https://api.skyprep.io/admin/api/get_login_key/ #示例参数{"user_email": 'dexter.morgan@www.jeanhegland.com', "autocreate": true, "key_type": "daily", "user_groups": "Forensics Lab;Miami PD Staff"} #示例响应{"email": "dexter.morgan@www.jeanhegland.com", "login_key": "abcdefghijklmnopqrstuvwxyz0123456789", "url":“https://yourskyprepdomain.skyprepapp.com/account/signin?username=dexter.morgan@www.jeanhegland.com&login_key = abcdefghijklmnopqrstuvwxyz012345689 "}
获得用户当前注册的所有课程(直接通过组和课程包)。
返回课程的JSON数组。
收到https://api.skyprep.io/admin/api/get_user_courses
收到https://api.skyprep.io/admin/api/get_user_courses #示例响应(数组)[{//Course JSON 1}、{//Course JSON 2}、//……更多课程]
用户数据可以批量注册到课程、组和课程包中。
邮递https://api.skyprep.io/admin/api/mass_enroll
获取https://api.skyprep.io/admin/api/mass_enroll #示例参数{"user_emails": "dexter@www.jeanhegland.com,james@www.jeanhegland.com" "course_ids": "84,96,101,323", "user_group_ids": "505,680,4,122", "course_bundle_ids": "222"} #示例响应{"message": "success"}
SkyPrep API允许你更新和删除课程。它还允许您将用户和用户组注册到课程中。
获取系统中的所有课程
得到https://api.skyprep.io/admin/api/get_courses
收到https://api.skyprep.io/admin/api/get_courses #示例响应[{//Course JSON 1},{//Course JSON 2}]
课程包含以下可更新的字段。beta API当前返回其他参数和信息,但只有以下参数可通过更新用户行动
收到https://api.skyprep.io/admin/api/get_course #示例参数{“课程id”:内部SkyPrep课程id(唯一)}示例响应{“id”:101,“名称”:“我的课程”,..//More JSON data}
创建一个课程。
邮递https://api.skyprep.io/admin/api/create_course
POST https://api.skyprep.io/admin/api/create_course #示例参数{"name": " practice to Perfect", "active": "true"} #示例响应{"id": "8877", "name": " practice to Perfect", ....}
更新课程。
文章https://api.skyprep.io/admin/api/update_course
邮递https://api.skyprep.io/admin/api/update_course #示例参数{“course_id”:“6294”,“name”:“How to Catch A Serial Killer”,“active”:“true”}示例响应{“message”:“success”}
从系统中永久删除课程。
邮递https://api.skyprep.io/admin/api/destroy_course
邮递https://api.skyprep.io/admin/api/destroy_course #样本参数{“课程id”:“8812”}样本响应{“消息”:“成功”}
可以使用API检索用户数据。
收到https://api.skyprep.io/admin/api/enroll_user_in_course
邮递https://api.skyprep.io/admin/api/enroll_user_in_course #示例参数{“用户\电子邮件”:dexter@www.jeanhegland.com,“课程id”:“144123”}样本响应{“消息”:“成功”}
文章https://api.skyprep.io/admin/api/remove_user_from_course
邮递https://api.skyprep.io/admin/api/remove_user_from_course #示例参数{“用户\电子邮件”:doakes@www.jeanhegland.com,“课程id”:“18872”}样本响应{“消息”:“成功”}
将单个用户注册到多个课程中。课程作为以逗号分隔的课程id列表传入
邮递https://api.skyprep.io/admin/api/enroll_user_in_courses
POST https://api.skyprep.io/admin/api/enroll_user_in_courses #示例参数{"user_id": "77121" "course_ids": "13,889,15,796,9788"} #示例响应{"message": "success"}
邮递https://api.skyprep.io/admin/api/add_course_to_user_group
POST https://api.skyprep.io/admin/api/add_course_to_user_group #示例参数{"user_group_id": "1821", "course_id": "123123"} #示例响应{"message": "success"}
OTP密钥是可以提供给学习者的课程注册密钥,以便他们可以使用课程自注册链接自注册课程。
它们类似于可以在SkyPrep界面中设置的课程的订阅密钥。唯一的区别是OTP密钥只能由单个用户使用一次。
OTP密钥对于需要提供有限的课程访问权限,但又不想提前注册用户的场景非常有用。您只需向他们发送密钥,他们就可以在准备就绪时注册。
OTP密钥对于销售课程也很有用。当买家购买课程时,您可以向他们提供OTP密钥和注册课程的链接。OTP密钥只能使用一次。
请注意,生成的OTP密钥与主密钥绑定订阅密钥
课程中的价值。如果订阅密钥
更改后,OTP密钥将失效,除非订阅密钥
恢复到以前的状态。
得到https://api.skyprep.io/admin/api/get_course_otp
获取https://api.skyprep.io/admin/api/get_course_otp #样本参数{"course_id": "171", "count": 2} #样本响应:["1234-5123-412","6712-zhja-181"]
可以使用API检索用户数据。
收到https://api.skyprep.io/admin/api/get_user_course_status
获取https://api.skyprep.io/admin/api/get_user_course_status #示例参数{"user_id": The internal SkyPrep user_id (unique) //或"user_email": "The users email", "course_id": "8781"} #示例响应{"status": "pass "}
将课程或学习路径添加到目录。此外,还可以按用户组限制对课程和学习路径的目录访问。
邮递https://api.skyprep.io/admin/api/add_course_or_learning_path_to_catalog
POST https://api.skyprep.io/admin/api/add_course_or_learning_path_to_catalog #示例参数{"course_ids": "90210, 55555", "learning_path_ids": "33162, 60606", "user_group_ids" " 77070,84060 "} #示例响应{"message": "success"}
从目录中删除课程或学习路径。这也将有效地消除课程或学习路径仅限于的用户组的可见性。
邮递https://api.skyprep.io/admin/api/remove_course_or_learning_path_from_catalog
邮递https://api.skyprep.io/admin/api/remove_course_or_learning_path_from_catalog #示例参数{“课程id”:“55555”//和/或“学习路径id”:“66890”}示例响应{“消息”:“成功”}
文章https://api.skyprep.io/admin/api/update_catalog_enrollments
邮递https://api.skyprep.io/admin/api/update_catalog_enrollments #示例参数{“课程id”:“9021055555”,“学习路径id”:“3316260606”,“用户组id”“770704060”}示例响应{“消息”:“成功”}
SkyPrep API允许添加、更新和删除用户组。
用户组(即组)是用户和课程的集合。注册到用户组的用户可以访问该用户组拥有的所有课程。
收到https://api.skyprep.io/admin/api/get_user_groups
获取用户组及其所有用户的列表。
收到https://api.skyprep.io/admin/api/get_user_group
#sample response {"name": "My Course", "users":[//用户列表]}
通过传入这些参数,可以通过API创建用户组(学习者、管理员、经理)
邮递https://api.skyprep.io/admin/api/create_user_group
邮递https://api.skyprep.io/admin/api/create_user_group #样本参数{“名称”:“销售团队”,“课程id”:“6934316090”,“用户id”:“3524545553”}样本响应{“id”:“123”,“名称”:“销售团队”…}
更新用户组
邮递https://api.skyprep.io/admin/api/update_user_group
删除用户组
邮递https://api.skyprep.io/admin/api/destroy_user_group
邮递https://api.skyprep.io/admin/api/destroy_user_group #示例参数{“用户组id”:“6612”}示例响应{“消息”:“成功”}
文章https://api.skyprep.io/admin/api/enroll_user_in_user_group
邮递https://api.skyprep.io/admin/api/enroll_user_in_user_group #示例参数{“用户id”:内部SkyPrep用户id(唯一)//或“用户电子邮件”:“用户电子邮件”}示例响应{“消息”:“成功”}
邮递https://api.skyprep.io/admin/api/remove_user_from_user_group
邮递https://api.skyprep.io/admin/api/remove_user_from_user_group #示例参数{“用户id”:“212”,“用户组id”:“7633”}示例响应{“消息”:“成功”}
获取用户所属组的列表。
收到https://api.skyprep.io/admin/api/get_user_group_enrollments_for_user
收到https://api.skyprep.io/admin/api/get_user #示例参数{“用户id”:内部SkyPrep用户id(唯一)//或“用户电子邮件”:“用户电子邮件”}示例响应[{“id”:“1234”,“名称”:“营销组”,…},{“id”:4512,“名称”:“销售组”,…},…]
邮递https://api.skyprep.io/admin/api/add_course_to_user_group
POST https://api.skyprep.io/admin/api/add_course_to_user_group #示例参数{"user_group_id": "1821", "course_id": "123123"} #示例响应{"message": "success"}
文章https://api.skyprep.io/admin/api/remove_course_from_user_group
POST https://api.skyprep.io/admin/api/remove_course_from_course_group #sample parameters {"course_id": SkyPrep内部课程id (unique) //OR "user_group_id": "The internal SkyPrep user_group_id"} #sample response {"message": "success"}
SkyPrep API允许您添加、更新和删除学习路径。
得到https://api.skyprep.io/admin/api/get_learning_paths
找到一条学习的道路。
收到https://api.skyprep.io/admin/api/get_learning_path
#样本参数{“learning_path_id”:“6401”}样本响应{“name”:“My learning path”,“description”:“learning path description”}
通过传入这些参数,可以通过API创建学习路径以及课程和用户注册
邮递https://api.skyprep.io/admin/api/create_learning_path
邮递https://api.skyprep.io/admin/api/create_learning_path #示例参数{“名称”:“管理101”,“描述”:“如何成功管理团队”“课程id”:“6934316090”,“用户id”:“3524545553”,“用户组id”:“111222333”}示例响应{“id”:“123”,“名称”:“管理101”…}
更新学习路径
邮递https://api.skyprep.io/admin/api/update_learning_path
邮递https://api.skyprep.io/admin/api/update_learning_path #示例参数{“学习路径id”:“1234”,“名称”:“新学习路径名称”,“描述”:“新学习路径描述”}示例响应{“消息”:“成功”}
删除学习路径
**请注意:这是一个不可逆的动作。请谨慎使用此路线。**
邮递https://api.skyprep.io/admin/api/destroy_learning_path
邮递https://api.skyprep.io/admin/api/destroy_learning_path #样本参数{“learning_path_id”:“6612”}样本响应{“message”:“success”}
邮递https://api.skyprep.io/admin/api/add_course_to_learning_path
POST https://api.skyprep.io/admin/api/add_course_to_learning_path #示例参数{"learning_path_id": "1821", "course_id": "123123"} #示例响应{"message": "success"}
文章https://api.skyprep.io/admin/api/remove_course_from_learning_path
POST https://api.skyprep.io/admin/api/remove_course_from_learning_path #sample parameters {"course_id": SkyPrep内部课程id(唯一)"learning_path_id": "The internal SkyPrep learning_path_id"} #sample response {"message": "success"}
邮递https://api.skyprep.io/admin/api/add_group_to_learning_path
POST https://api.skyprep.io/admin/api/add_group_to_learning_path #示例参数{"learning_path_id": "1821", "user_group_id": "123123"} #示例响应{"message": "success"}
邮递https://api.skyprep.io/admin/api/remove_group_from_learning_path
邮递https://api.skyprep.io/admin/api/remove_group_from_course_group #示例参数{“用户组id”:内部SkyPrep组id(唯一)“学习路径id”:“内部SkyPrep学习路径id”}示例响应{“消息”:“成功”}
SkyPrep API允许您添加、更新和删除教练引导的培训。
得到https://api.skyprep.io/admin/api/get_instructor_led_trainings
参加教练指导的培训。
得到https://api.skyprep.io/admin/api/get_instructor_led_training
#示例参数{"instructor_led_training_id": "543"} #示例响应{"name": "My trainer Led Training", "description": " trainer Led Training"}
找一个教练指导的训练时段。
收到https://api.skyprep.io/admin/api/get_instructor_led_training_timeslot
#样本参数{“讲师领导的培训时间段{u id:“555”}样本响应{“描述”:“讲师领导的培训时间段描述”,“位置”:“时间段位置”,“讲师”:“讲师姓名”}
获取讲师指导的培训时间段集合。
收到https://api.skyprep.io/admin/api/get_instructor_led_training_timeslots
#示例参数{"start_date": "2020-01-01", "end_date": "2020-02-01"} #示例响应{"description": "指导者主导的培训时点描述","location": "时点位置","指导者":"指导者姓名"}
通过传入这些参数,可以通过API创建指导者引导的培训时隙
邮递https://api.skyprep.io/admin/api/create_instructor_led_training_timeslot
邮递https://api.skyprep.io/admin/api/create_instructor_led_training_timeslot #示例参数{“讲师指导的培训id”:“555”,“显示时区”:“UTC”,“描述”:“一些描述”,“容量”:“555”}响应{“id”:“666”,“容量”:“555”,“显示时区”:“UTC”,“描述”:“一些描述”}
通过传入这些参数,可以通过API更新教员主导的培训时隙
文章https://api.skyprep.io/admin/api/update_instructor_led_training_timeslot
邮递https://api.skyprep.io/admin/api/update_instructor_led_training_timeslot #示例参数{“讲师指导的培训”时隙id:“111”,“显示时区”:“UTC”,“描述”:“一些描述”,“容量”:“555”}响应{“id”:“111”,“容量”:“555”,“显示时区”:“UTC”,“描述”:“一些描述”}
删除讲师指导的培训时间段
**请注意:这是一个不可逆的动作。请谨慎使用此路线。**
邮递https://api.skyprep.io/admin/api/delete_instructor_led_training_timeslot
邮递https://api.skyprep.io/admin/api/delete_instructor_led_training_timeslot #示例参数{“讲师领导的培训时间段{id:“6612”}示例响应{“消息”:“成功”}
获得教练带领的训练时段登记。
收到https://api.skyprep.io/admin/api/get_instructor_led_training_timeslot_registrations
#样本参数{“讲师领导的培训时间段{u id:“555”}样本响应{“描述”:“讲师领导的培训时间段描述”,“位置”:“时间段位置”,“讲师”:“讲师姓名”}
通过传入这些参数,可以通过API创建讲师指导的培训时间段注册
邮递https://api.skyprep.io/admin/api/create_instructor_led_training_timeslot_registrations
邮递https://api.skyprep.io/admin/api/create_instructor_led_training_timeslot_registrations #样本参数{“讲师指导的培训时间段id:”555“,”用户id:”111“,”课程进度id:”444“,”课程id:”333“,”状态“:”参加”}样本响应{“id:”666“,”状态“:”参加“,”用户id:”111“
删除讲师指导的培训时间段注册
**请注意:这是一个不可逆的动作。请谨慎使用此路线。**
邮递https://api.skyprep.io/admin/api/destroy_instructor_led_training_timeslot_registrations
邮递https://api.skyprep.io/admin/api/destroy_instructor_led_training_timeslot_registrations #示例参数{“讲师指导的培训时间段注册ID”:“661246578”}示例响应{“消息”:“成功”}
更新讲师指导的培训时间段注册
邮递https://api.skyprep.io/admin/api/update_instructor_led_training_timeslot_registration
POST https://api.skyprep.io/admin/api/update_instructor_led_training_timeslot_registration #sample parameters {"instructor_led_training_timeslot_registration_id": "6612", "status": "attended"} #sample response {"instructor_led_training_timeslot_registration_id": "6612", "status": "attended"…}
SkyPrep API允许你在课程中更新和删除用户的课程进度。
收到https://api.skyprep.io/admin/api/get_course_progresses
激活、不激活或禁用
(逗号分隔)通过、失败、未启动或正在进行中
(逗号分隔)收到https://api.skyprep.io/admin/api/get_course_progresses #样本参数{“课程id”:“8812”}样本响应[{“id”:21869068,“状态”:“通过”,“截止日期前的天数”:null,“创建时间”:“2020-03-21T12:02:11.000Z”,“更新时间”:“2021-04-08T22:36:07.000Z”,“跳过先决条件”:false,“课程id”:06,“课程名称”:“普通考试课程”,“用户id”:590142,“用户电子邮件”:aaron@example.com,“开始日期”:null,“完成日期”:“2020-11-06T00:40:18.000Z”,“最后课程项目id”:null,“浏览百分比”:0,“过期日期”:null,“过期日期”:false,“访问日期”:null,“截止日期”:null,“覆盖日期”:false,“实际结束日期”:null实际开始日期:null,“证书查看链接”:https://sampleapi.skyprepapp.com/certificates/show?course_progress_id=21869068&f=pdf“,“计算的截止日期”:null,“格式化的截止日期”:”“格式化的截止日期”:”“2020年11月6日”“格式化的截止日期”:”“格式化的访问日期”:”“格式化的截止日期”:”格式化的实际结束日期:“,”格式化的实际开始日期:“,”格式化的计算截止日期:“,”]
获得课程进步
得到https://api.skyprep.io/admin/api/get_course_progress
得到https://api.skyprep.io/admin/api/get_course_progress样本参数{" course_progress_id ": " 96854 "} #示例响应{" id ": 21869068,“状态”:“通过”,“days_until_deadline”:空,“created_at”:“2020 - 03 - 21 t12:02:11.000z”、“updated_at”:“2021 - 04 - 08 - t22:36:07.000z”、“skip_prerequisites”:假的,“course_id”:50606年,“course_name”:“普通考试课程”、“user_id”:590142年,“user_email”:“aaron@example.com”、“commencement_date”:空,“completion_date”:“2020 - 11 - 06 t00:40:18.000z”、“last_course_item_id”:空,“percent_viewed”:0,“expiration_date”:空,“过期”:假的,“access_date”:空,“deadline_date”:空,“override_dates”:假的,“real_end_date”:空,“real_start_date”:空,“certificate_view_link”:“https://sampleapi.skyprepapp.com/certificates/show?course_progress_id=21869068&f=pdf”,“computed_deadline_date”:空,“formatted_commencement_date”:“”,“formatted_completion_date”:“06-Nov 2020”,“formatted_expiration_date”:“”,“formatted_access_date”:“”,“formatted_deadline_date”:", "formatted_real_end_date": "", "formatted_real_start_date": "", "formatted_computed_deadline_date": ""}
更新课程进度
邮递https://api.skyprep.io/admin/api/update_course_progress
通过,失败,进行中,不适用,未启动
POST https://api.skyprep.io/admin/api/update_course_progress #示例参数{"course_progress_id": "96854", "set_status": "failed"} #示例响应{"message": "success"}
从系统中永久删除课程进度
邮递https://api.skyprep.io/admin/api/destroy_course_progress
邮递https://api.skyprep.io/admin/api/destroy_course_progress #示例参数{“课程进度id”:“96854”}示例响应{“消息”:“成功”}
为用户获取课程项目的进度。
这个调用需要exam_id、user_id、course_id、course_progress_id和course_item_id的某种组合,以便API通过特定的course_item返回用户进度的状态。
例如,如果指定课程项目id和用户id,系统将找出属于该课程项目的课程,获取该课程中用户的课程进度,然后获取该课程进度的课程项目进度。
另一个示例。如果指定考试id和课程进度id,系统将查找课程进度,找出用户和课程,并查找该课程中与考试id匹配的第一个课程项目,然后返回该课程项目的用户课程进度。
收到https://api.skyprep.io/admin/api/get_course_item_progress
收到https://api.skyprep.io/admin/api/get_course_item_progress #样本参数{“课程id”:“1234”,“用户id”:“5223”,“课程项目id”:“5231”,样本响应{“消息”:“成功”}
为课程中的用户设置课程项的进度
文章https://api.skyprep.io/admin/api/set_course_item_progress
邮递https://api.skyprep.io/admin/api/set_course_item_progress #样本参数{“user_id”:“124112”,“set_status”:“failed”}样本响应{“message”:“success”}
SkyPrep API允许您生成CSV报告。
可以通过传入report_type
参数以及报告所需的其他参数(例如:用户id
,课程号
,考试id
等等)。
邮递https://api.skyprep.io/admin/api/get_report
csv
(默认)xlsx
all_users
all_courses
single_user
single_course
single_user_single_course
单用户单组
单个用户组所有用户
single_group_all_courses
单科考试
获取https://api.skyprep.io/admin/api/get_report #示例参数{"report_type": "single_course_single_user", "user_id": "41", "course_id": "88"}
可以通过传入report_type
参数以及报告所需的其他参数(例如:用户id
,课程号
,考试id
等等)。
A.状态url
返回,您可以访问它以获取报告的状态和数据(准备就绪时)。
文章https://api.skyprep.io/admin/api/generate_async_report
csv
(默认)xlsx
all_users
all_courses
single_user
single_course
single_user_single_course
单用户单组
单个用户组所有用户
single_group_all_courses
单科考试
获取https://api.skyprep.io/admin/api/generate_async_report #示例参数{"report_type": "all_users", "format": "csv"} #示例响应{"status_url": "https://api.skyprepapp.com/admin/api/get_async_report?report_id=1234"}
SkyPrep API可以让你获得用户平衡,并创建游戏化交易,为用户分配点数。
让用户保持游戏化平衡。
收到https://api.skyprep.io/admin/api/get_user_gamification_balance
#示例参数{“电子邮件”:testuser@example.com“}#样本响应{”游戏化#平衡:700}”
通过传入这些参数,可以通过API为用户创建游戏化事务
邮递https://api.skyprep.io/admin/api/create_gamification_transaction
邮递https://api.skyprep.io/admin/api/create_gamification_transaction #样本参数{“用户id”:12345,“金额”:-200,“说明”:“在另一个平台上消费扣分”}样本响应{“id”:5678,“用户id”:12345,“金额”:200,“说明”:“在另一个平台上消费扣分”,“余额”:900,“唯一交易id”:“ebbb00e005dcbd439894d86b7fcf8eeb94c1f66e11c66843fb4bda1bd154159f”,}
SkyPrep API允许您分配与组关联的管理器权限。
从用户组获取管理员权限。
得到https://api.skyprep.io/admin/api/get_manager_permissions_from_user_group
#样本参数{“用户id”:“90210”,“用户组id”:“888”}样本响应{“id”:“2006”,“用户”:{“id”:“2”“用户名”:“rita”。bennett@www.jeanhegland.com“,”名字“:”丽塔“,”姓氏“:”贝内特“,”可以添加用户“:”真“,”可以接收用户通知“:”真“,”可以编辑课程进度“:”真“,”可以删除用户“:”假“,“can_add_existing_users”:“false”,“user_group”:{“id”:“333”,“name”:“Miami Metro Police Department”},“can_managed_group_users_courses”:“false”,“can_add_courses_to_user_group”:“true”,“can_从_user_group中删除_courses”:“true”,“can_edit_user_password”:“false”}
从用户组中删除管理器。
收到https://api.skyprep.io/admin/api/remove_manager_from_user_group
#示例参数{"user_id": "90210", "user_group_id": "888"} #示例响应{"message": "success"}
将管理器分配给用户组。
收到https://api.skyprep.io/admin/api/assign_manager_to_user_group
#样本参数{“用户id”:“90210”,“用户组id”:“888”,“可以将课程添加到用户组”:“0”,“可以从用户组中删除课程”:“0”,样本响应{“id”:“2006”,“用户”:{“id”:“2”“用户名”:“rita”。bennett@www.jeanhegland.com“,”姓“:”丽塔“,”姓“:”贝内特“}”,可以添加用户“:”真“,”是否可以收到通知:“真”、“可以编辑课程进度”:“真”、“可以删除用户”:“假”、“可以添加现有用户”:“假”、“用户组”:{“id”:“333”、“名称”:“迈阿密地铁警察局”},“可以管理所有组用户课程”:“假”、“可以添加课程到用户组”:“假”、“可以从用户组删除课程”:“假”:”false”,“可以编辑用户密码”:“false”}
更新用户组中的管理员权限。
得到https://api.skyprep.io/admin/api/update_manager_permissions_in_user_group
#示例参数{“用户id”:“90210”,“用户组id”:“888”“可以向用户组添加课程”:“0”,“可以从用户组中删除课程”:“0”,“0”}示例响应{“id”:“2006”,“用户”:{“id”:“2”“用户名”:“rita”。bennett@www.jeanhegland.com“,”名字“:”丽塔“,”姓氏“:”贝内特“}”,可以添加用户“:”真“,“是否可以接收通知”:“真”,“可以编辑课程进度”:“真”,“可以删除用户”:“假”,“可以添加现有用户”:“假”,“用户组”:{“id”:“333”,“名称”:“迈阿密地铁警察局”},“可以管理所有组用户课程”:“假”,“可以添加课程到用户组”:“假”,“可以从用户组删除课程”:”false”,“可以编辑用户密码”:“false”}
SkyPrep API允许您更新您的SkyPrep帐户。
您的SkyPrep帐户信息。
收到https://api.skyprep.io/admin/api/get_program
获取https://api.skyprep.io/admin/api/get_program #sample response {"acct_key": "myapp.skyprepapp.com", "name": "Your SkyPrep Training Program", //更多JSON数据}
获取有关您的平台的数据/统计信息
收到https://api.skyprep.io/admin/api/get_data
用户计数,
admin_count,
学习者(u)计数,,
当然!,
user_group_count
收到https://api.skyprep.io/admin/api/get_data #样本参数{“数据类型”:“学习者计数”}样本响应{“数据”:“587”}
SkyPrep API允许您获取内容。
获取平台中的所有材料
收到https://api.skyprep.io/admin/api/get_materials
收到https://api.skyprep.io/admin/api/get_materials #样本响应[{//Material 1},{//Material 2}]