Skilljar API端点引用
此页面记录Skilljar平台支持的API端点。它是从我们的源代码自动生成的,因此在添加其他操作时保持最新。要了解Skilljar API并了解对象在课程平台中的结构,最好从以下文章开始:
域
access-code-pools >读
检索访问代码池详细信息。响应示例:{"id": "abcde1234", "name": " Example -pool", "active": true, "start_date": 2016-01-29T00:22:00.590250Z, "end_date": null, "expire_linked_to_domain_membership": false, "channel": "api", "code_count": 1}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
|
访问\u代码\u池\u id 必修的 |
一串 |
access-code-pools >更新
更新访问码池。PUT和PATCH是相同的——两者都做部分更新。
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
|
访问\u代码\u池\u id 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
名称 |
访问代码池的名称。这可能是在仪表板中创建单个代码时自动生成的。 | 一串 |
忙碌的 |
布尔值 |
|
开始日期 |
一串 |
|
end_date |
一串 |
|
expire_linked_to_domain_membership |
当此值为true并设置了end_date时,使用此池中的代码注册的用户将失去对end_date域的访问权。 | 布尔值 |
access-code-pools > partial_update
更新访问码池。PUT和PATCH是相同的——两者都做部分更新。
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
|
访问\u代码\u池\u id 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
名称 |
访问代码池的名称。这可能是在仪表板中创建单个代码时自动生成的。 | 一串 |
忙碌的 |
布尔值 |
|
开始日期 |
一串 |
|
end_date |
一串 |
|
expire_linked_to_domain_membership |
当此值为true并设置了end_date时,使用此池中的代码注册的用户将失去对end_date域的访问权。 | 布尔值 |
Access-code-pools > access-codes > list
列出池中的访问代码。返回访问代码的分页列表(每页1000个结果)。响应示例:{“count”:1,“next”:null,“previous”:null,“results”:[{“id”:“abcde12345”,“code”:“examplecode”,“active”:true,“max_uses”:3,“use_count”:2,“duration”:null,“duration_unit”:“MONTHS”}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
|
访问\u代码\u池\u id 必修的 |
一串 |
查询参数
以下参数应作为URL查询字符串的一部分包含。
参数 | 描述 | 类型 |
---|---|---|
页 |
分页结果集中的页码。 | 整数 |
页面大小 |
每页返回的结果数。 | 整数 |
访问代码池>访问代码>读取
检索访问代码细节。响应示例:{"code": "examplecode", "active": true, "max_uses": 3, "use_count": 2, "duration": null, "duration_unit": "Months" "users": [{"id": "abcdef12345", "email": "janedoe@example.com", "first_name": "Jane", "last_name": "Doe"}, {"id": "bcdeg23456", "email": "jamesdoe@example.com", "first_name": "James", "last_name": "Doe"},]}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
|
访问\u代码\u池\u id 必修的 |
一串 |
|
访问\u代码\u id 必修的 |
一串 |
已发布课程>列表
列出发布到某个领域的课程。返回已发表课程的分页列表(每页100个结果)。响应示例:{"count": 1, "next": null, "previous": null, "results": [{"id": "abcdefg123456", "course": {"id": "cdefghi345678", "title": "Example title"}, "slug": "Example -course", "course_url": "http://learn.example.com/example-course", "hidden": false, "registration_required": true, "registration_starts_at":"2017-11-28T08:00:00Z", "registration_ends_at": "2018-09-30T06:00:00Z", "timezone": "US/Pacific", "offer": {"id": "bcdefgh234567", "registration_open": true, "registration_url": "http://learn.example.com/checkout/bcdefgh234567", "price": {"amount": "100.00", "currency_code": "USD"}}}]}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
查询参数
以下参数应作为URL查询字符串的一部分包含。
参数 | 描述 | 类型 |
---|---|---|
页 |
分页结果集中的页码。 | 整数 |
include_searchable_content |
如果设置为True,响应还包括以下字段('lesson_list', 'tags', 'short_description', 'long_description_html', 'search_keywords') | 一串 |
搜索 |
URL编码的字符串,返回结果和顺序,就像目录搜索一样 | 一串 |
已发布课程>注册>列表
列出已发表课程的注册人数。一个用户可以有多个注册,如果至少有一个注册是活跃的并且没有过期,那么他就可以访问课程。如果注册是与购买关联创建的,或者是通过课程平台UI注册的,那么购买细节将包含在响应中。返回注册的分页列表(每页1000个结果)。示例响应:{“计数”:1、“下一个”:空,“之前”:空,“结果”:[{" id ":“abcdefg123456”,“用户”:{" id ":“bcdefga123456”、“电子邮件”:“jane@doe.com”、“first_name”:“简”、“last_name”:“母鹿”,},“enrolled_at”:“2015 - 01 - 29 t00:22:00.590250z”、“expires_at”:空,“活动”:真的,"购买":{“order_id”:“”,“offer_price”:{“金额”:"100.00", "currency_code": "USD"}, "purchase_price": {"amount": "50.00", "currency_code": "USD"}, "quantity": 1, "purchase_state": "SUCCESS", "payment_processor": "STRIPE"}}]}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
|
published_course_id 必修的 |
一串 |
查询参数
以下参数应作为URL查询字符串的一部分包含。
参数 | 描述 | 类型 |
---|---|---|
页 |
分页结果集中的页码。 | 整数 |
页面大小 |
每页返回的结果数。 | 整数 |
已发布课程>注册>创建
在已发布课程中注册用户。此操作在user.id和注册的\u的组合上是幂等的。多次发布到此终结点不会为现有用户创建新的注册。在组合中,id&Registered\u。但是,如果user.id或registered_at参数与现有注册不匹配,则每次调用都将创建新注册。采购状态='CREATED'、'PENDING'、'SUCCESS'、'FAILED'、'returned'、'CANCELLED'或'FLAGGED'示例帖子正文(如果发布JSON而不是表单编码参数):{“user”:{“id”:“abcde12345”,},“登记于”:“2018-03-12T10:12:45Z”,“到期日期”:“2018-05-12T10:12:45Z”,“active”:true,“采购”:“采购状态”:“SUCCESS”,“购买价格”:{“金额”:“5.00”,“货币代码”:“USD”},“购买地点”:“2018-02-12T10:12:45Z”,“税费价格”:100}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
|
published_course_id 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
用户 必修的 |
对象 |
|
enrolled_at |
一串 |
|
过期于 |
一串 |
|
忙碌的 |
布尔值 |
|
购买 |
对象 |
已发布路径>列表
返回发布到域的路径列表。返回已发布路径的分页列表(每页100个结果)。示例响应:{“计数”:1、“下一个”:空,“之前”:空,“结果”:[{“id”:“abcdefg123456”、“路径”:{" id ":“cdefghi345678”,“标题”:“示例路径名称”,“path_item_count”:0},“path_url”:“http://learn.example.com/path/example-path-title”,“提供”:{" id ":“bcdefgh234567”、“registration_open”:真的,“registration_url”:"http://learn.example.com/checkout/bcdefgh234567", "price": {"amount": "20.00", "currency_code": "USD"}}}]}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
查询参数
以下参数应作为URL查询字符串的一部分包含。
参数 | 描述 | 类型 |
---|---|---|
页 |
分页结果集中的页码。 | 整数 |
用户>列表
列出域的用户。返回域用户详细信息的分页列表(每页1000个结果)。示例响应:{“计数”:2,“下一个”:空,“之前”:空,“结果”:[{"用户":{" id ":“opqrstu345678”、“电子邮件”:“joe@example.com”、“first_name”:“乔”,“last_name”:“用户”},“活动”:真的,“marketing_optin”:空,“enrolled_at”:“2015 - 01 - 29 t00:22:00.590250z”、“expires_at”:空,“access_code”:零},{"用户":{" id ":“cdefghi567890”、“电子邮件”:“jane@example.com”、“first_name”:“简”、“last_name”:“母鹿”},“活动”:假的,“marketing_optin”:空,“enrolled_at”:“2015 - 02 - 15 t00:43:10.123456z”、“expires_at”:空,“access_code”:{" id ":“defghij678901”、“代码”:“opensesame”,“池”:{" id ":“efghijk789012”、“名称”:“精灵代码 " } } } ] }
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
查询参数
以下参数应作为URL查询字符串的一部分包含。
参数 | 描述 | 类型 |
---|---|---|
页 |
分页结果集中的页码。 | 整数 |
页面大小 |
每页返回的结果数。 | 整数 |
user__email |
通过电子邮件地址过滤域用户 | 一串 |
用户名 |
过滤域用户的名字-区分大小写 | 一串 |
user__last_name |
按姓氏区分大小写过滤域用户 | 一串 |
忙碌的 |
按活动筛选域用户(正确或错误) | 一串 |
access_code__code |
根据使用的访问代码过滤域用户-区分大小写 | 一串 |
access_code__id |
根据使用的访问代码的id过滤域用户-不区分大小写 | 一串 |
access_code__pool__id |
根据使用的访问码池id过滤域用户-不区分大小写 | 一串 |
access_code |
使用“null”值可查看访问域但没有访问代码的域用户。此查询不接受其他值。 | 一串 |
用户>创建
将用户添加到域。用户必须具有唯一的电子邮件地址。您可以将现有用户(现有电子邮件地址)发布到域中,呼叫仍将成功返回,并显示现有用户详细信息。如果您向域发布新用户电子邮件,则该呼叫将在系统中创建新用户。示例帖子正文(如果发布JSON而不是表单编码参数):{“用户”:{“电子邮件”:”bob@example.com“,”姓“:”鲍勃“,”姓“:”用户“}}}示例响应:{”用户“:{”id“:”qrstuvw321098“,”电子邮件“:”bob@example.com“,”名字“:”鲍勃“,”姓氏“:”用户“},“活动”:真,“营销选项”:空,“注册地点”:“2015-01-29T00:22:00.590250Z”,“过期时间”:null,“访问代码”:null,“登录令牌”:“qrstuvw321098-3xn-a1b23cd456dfg7890hijk”}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
用户 必修的 |
用户详细信息 | 对象 |
忙碌的 |
只有活动用户可以访问私有域 | 布尔值 |
marketing_optin |
表示用户已接受或拒绝营销选项消息。Null表示未向用户显示任何营销选项消息 | 布尔值 |
过期于 |
ISO 8601格式化的datetime字符串,指示对域的访问将在何时到期——在公共域上忽略 | 一串 |
用户>注册字段>创建
创建或更新用户的注册字段值。如果用户没有分配给post注册字段的当前值,则此端点将为用户创建一个新的注册字段值。如果用户已经拥有与注册字段相关联的值,那么它将被更新为post值。示例POST主体(如果是POST JSON而不是form-encoded parameters): {"signup_field": {"id": "abcd1234"}, "value": "My Signupfield value"}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
域名 必修的 |
一串 |
|
user_id 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
注册字段 必修的 |
对象 |
|
价值 必修的 |
一串 |
组
用户>列表
列出组内用户。返回组用户详细信息的分页列表(每页1000个结果)。Response: {"count": 2, "next": null, "previous": null, "results": [{"user": {"id": "opqrstu345678", "email": "joe@example.com", "first_name": "Joe", "last_name": "user"}, "created_at": "2015-02-19T19:20:24.671362Z"}, {"user": {"id": "cdefghi567890", "email": "jane@example.com", "first_name": "Jane", "last_name":“母鹿”},“created_at”:“2015 - 02 - 18 t10:37:48.543927z”}]}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
group_id 必修的 |
一串 |
查询参数
以下参数应作为URL查询字符串的一部分包含。
参数 | 描述 | 类型 |
---|---|---|
页 |
分页结果集中的页码。 | 整数 |
页面大小 |
每页返回的结果数。 | 整数 |
课程进展
使现代化
更新课程进度。PUT和PATCH是相同的-都进行部分更新。将finished_设置为表示学生已完成内容。这也将标记课程完成,除非课程需要验证,例如检查程序。要取消完成课程,请将completed_at设置为null。
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
课程\进度\ id 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
完成于 |
ISO 8601格式化的datetime字符串,表示用户完成课程内容的时间。设置此字段也将标记课程完成,除非课程需要验证,例如审查监考。 | 一串 |
completed_at |
ISO 8601格式化的日期时间字符串,指示用户完成课程的时间。如果为空,则表示用户尚未完成课程。 | 一串 |
成功与地位 |
'PASSED', 'FAILED'或null | 枚举 |
分数 |
得分 | 整数 |
max_score |
最大可能的得分 | 整数 |
custom_data |
一串 |
|
validation_status |
'PASSED', 'FAILED'或null | 枚举 |
validation_data |
JSON格式化。如果课程不需要验证,则忽略。 | 对象 |
部分更新
课程进度的部分更新。PUT和PATCH是相同的-都进行部分更新。将finished_设置为表示学生已完成内容。这也将标记课程完成,除非课程需要验证,例如检查程序。要取消完成课程,请将completed_at设置为null。
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
课程\进度\ id 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
完成于 |
ISO 8601格式化的datetime字符串,表示用户完成课程内容的时间。设置此字段也将标记课程完成,除非课程需要验证,例如审查监考。 | 一串 |
completed_at |
ISO 8601格式化的日期时间字符串,指示用户完成课程的时间。如果为空,则表示用户尚未完成课程。 | 一串 |
成功与地位 |
'PASSED', 'FAILED'或null | 枚举 |
分数 |
得分 | 整数 |
max_score |
最大可能的得分 | 整数 |
custom_data |
一串 |
|
validation_status |
'PASSED', 'FAILED'或null | 枚举 |
validation_data |
JSON格式化。如果课程不需要验证,则忽略。 | 对象 |
提供
路径
路径项目>列表
返回路径项对象的列表示例响应:{“count”:1,“next”:null,“previous”:null,“results”:[{“id”:“qwerty1234”,“slug”:“test-Path-1”,“course”:{“id”:“abcdefg1234”,“title”:“test-Path-course 1”,“lessure\u count”:3,“required\u-lessment\u-lessure\u-count”:3}}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
path_id 必修的 |
一串 |
查询参数
以下参数应作为URL查询字符串的一部分包含。
参数 | 描述 | 类型 |
---|---|---|
页 |
分页结果集中的页码。 | 整数 |
平
progresstokens
promo-code-pools
创造
创建一个PromoCodePool例子后的身体(如果发布JSON而不是表单编码的参数):{“名称”:“promo-code-pool-name-1”,“活动”:真的,“discount_type”:“PERCENT_OFF”、“PERCENT_OFF”:100年,“single_use_per_user”:假的,“starts_at”:“2018 - 03 - 16 t16:45:55.946094z”、“expires_at”:“2018 - 10 - 16 t16:45:55.946094z}或{“名称”:" promoc -code-pool-name-1", "active": true, "discount_type": "PRICE_OVERRIDE", "price_cents": 5000, "single_use_per_user": false, "starts_at": "2018-03-16 t16:45:55 946094z ", "expires_at": "2018-10-16 t16:45:55 946094z ",}
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
名称 必修的 |
一串 |
|
忙碌的 |
布尔值 |
|
starts_at 必修的 |
ISO 8601格式化的日期时间字符串,表示促销代码池的开始 | 一串 |
过期于 |
ISO 8601格式化的日期时间字符串,表示促销代码池的过期 | 一串 |
折扣类型 必修的 |
枚举 |
|
price_cents |
整数 |
|
折成 |
整数 |
|
单个用户使用每个用户 |
布尔值 |
提供>创建
将报价附加到PromotCodePool。每笔交易最多可向PromoCodePool添加500个优惠。示例发布正文(如果发布JSON而不是表单编码参数):{“id”:“abcde12345”}或[{“id”:“bcdef23456”},{“id”:“cdefg34567”},{“id”:“defgh45678”},{“id”:“efghi56789”}]
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
促销代码池id 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
id |
提供您希望附加到PromoCodePool的ID | 一串 |
促销代码
购买
读
得到购买细节。
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
purchase_id 必修的 |
Purchase对象的ID | 一串 |
响应对象
响应对象是“application / JSON”
已编码的对象,包含以下项。
参数 | 描述 |
---|---|
id |
采购对象的(内部)ID |
用户 |
创建Purchase对象的用户对象 |
状态信息 |
购买付款失败时的状态消息 |
于购买 |
Purchase对象创建的日期 |
退还 |
被拒绝的购买被退款的日期(如果) |
退款0美分 |
(如果)反对购买的金额被退回 |
payment_processor |
付款处理器 |
order_id |
Purchase的惟一订单ID |
price_cents |
所购买物品的价格(美分) |
数量 |
购买物品数量 |
offer_id |
(内部)购买的报价的ID |
报价单 |
(内部)所购买的要约SKU |
offer_description |
所购要约的说明 |
报价(美分) |
购买要约的价格(美分) |
促销代码价格美分 |
所用促销代码的价格(单位:美分) |
促销代码折扣百分比 |
促销代码折扣百分比 |
促销代码数量 |
使用的促销代码数量 |
tax_price_cents |
购买的地方税价格(美分) |
付款\处理程序\订单\ id |
所使用的支付处理器的ID |
payment_processor_response_data |
使用的支付处理程序的响应 |
货币代码 |
购买时使用的货币类型 |
完成
满足特定的购买。更新购买状态,如果“成功”,完成购买,创建任何必要的课程或域名注册。
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
purchase_id 必修的 |
一串 |
请求主体
请求体应该是“application / JSON”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
状态 必修的 |
'SUCCESS', 'FAILED',或'CANCELLED' | 枚举 |
错误消息 |
可选:这个错误消息将在用户返回Skilljar后显示给他们,并将被设置为购买的status_msg | 一串 |
付款\处理程序\订单\ id |
可选:支付处理器系统内交易的id,仅供参考 | 一串 |
payment_processor_response_data |
可选:购买元数据。仅供参考。建议使用JSON格式 | 一串 |
用户
已发布课程>更新
更新用户的课程进度。PUT和PATCH是相同的——两者都做部分更新。要将一门课程标记为完成,只需要在课程进度中设置completed_at。例如:{"course_progress": {"completed_at": "2015-06-03T01:02:03.012345Z", "success_status": "PASSED"}}
路径参数
URL路径中应该包含以下参数。
参数 | 描述 | 类型 |
---|---|---|
user_id 必修的 |
一串 |
|
published_course_id 必修的 |
一串 |
请求主体
请求体应该是“application / json”
编码,并应包含单个项。
参数 | 描述 | 类型 |
---|---|---|
published_course_id |
已发布课程的ID | 一串 |
课程进展 必修的 |
对象 |
vilt会话事件
列表
ViltSessionEvents列表。根据提供的筛选器返回一个分页列表。
查询参数
以下参数应作为URL查询字符串的一部分包含。
参数 | 描述 | 类型 |
---|---|---|
页 |
分页结果集中的页码。 | 整数 |
页面大小 |
每页返回的结果数。 | 整数 |
session__lesson__course__id |
通过与Course ID的精确匹配过滤ViltSessionEvents | 一串 |
session__lesson__id |
按课程ID的精确匹配筛选ViltSessionEvents | 一串 |
开始于 |
在ViltSessionEvent大于或等于start at值的地方进行筛选。Datetime格式 | 一串 |
ends_at__lte |
筛选ViltSessionEvent小于或等于结束值的地方。Datetime格式 | 一串 |