README

Um SDK Simples para a API do MemberKit usando PHP

索引

安装
配置
交易

安装

使用以下命令安装库

composer require fgubert/memberkit-php-sdk

配置

要将库包含到项目中，请执行以下操作

<?php
require('vendor/autoload.php');

$mk = new MemberKit\Client('SUA_CHAVE_DE_API');

然后，您可以使用客户端根据API集成文档进行请求，文档可在以下地址找到：https://gist.github.com/rainerborene/26bc6b66bbc5dd4f78a1141df31ef718

交易

本节将解释如何使用SDK进行MemberKit API交易。

列出所有会员区域中的活跃订阅

<?php
$test = $mk->membership_levels();

列出所有会员区域中的活跃课程

<?php
$test = $mk->classrooms();

列出排名中成员及其累积分数

<?php
$test = $mk->rankings($classrom_id);

列出特定成员的分数

<?php
$test = $mk->user_ranking($user_id);

列出特定成员的活动流

<?php
$test = $mk->user_activities($email);

列出所有注册的课程

<?php
$test = $mk->courses();

返回课程的基本数据，包括模块和相应的课程

<?php
$test = $mk->course($course_id);

返回特定课程的数据

<?php
$test = $mk->lesson($course_id, $lesson_id);

生成一个有效期为1小时的新的认证令牌

<?php
$test = $mk->token($email);

注册或更新学生

重要：Memberkit有三个访问级别：单个注册、无限访问或订阅。在发送请求时，请使用参数classroom_ids、unlimited或membership_level_id指定一种注册方式。

<?php
$test = $mk->newUser($full_name, $email, $status='active', $blocked=false, $classroom_ids=array(), $unlimited=false, $membership_level_id=null, $expires_at=null);

添加新的分数

手动向学生排名添加分数。

<?php
$test = $mk->scores($user_email, $reason, $value, $course_id);

删除手动添加的分数

要移除添加到学生排名中的手动分数，您必须提供与添加时相同的理由（字段reason）。

<?php
$test = $mk->delete_scores($user_email, $reason, $course_id);

标记课程中的所有课程为未完成

为特定学生标记课程中的所有课程为未完成。

<?php
$test = $mk->delete_lesson_statuses($user_email, $course_id);

fgubert / memberkit-php-sdk

维护者

详细信息