fgubert / memberkit-php-sdk
Simple PHP SDK for MemberKit API
Requires
- guzzlehttp/guzzle: ^7.2
README
Um SDK Simples para a API do MemberKit usando PHP
Índice
- Instalação
- Configuração
- Transações
- Lista todas as assinaturas ativas na área de membros
- Lista todas as turmas ativas na área de membros
- Lista os membros e respectivas pontuações acumuladas no ranking
- Lista as pontuações de um membro específico
- Lista feeds de atividades de um membro específico
- Lista todos os cursos cadastrados
- Retorna dados básicos do curso com módulos e respectivas aulas
- Retorna dados completo de uma aula específica
- Gera um novo token de autenticação com duração de 1 hora
- Cadastrar ou Atualizar um Aluno
- Adiciona uma nova pontuação
- Remove a pontuação adicionada manualmente
- Marca todas as aulas de um curso como não concluídas
Instalação
Instale a biblioteca utilizando o comando
composer require fgubert/memberkit-php-sdk
Configuração
Para incluir a biblioteca em seu projeto, basta fazer o seguinte:
<?php require('vendor/autoload.php'); $mk = new MemberKit\Client('SUA_CHAVE_DE_API');
E então, você pode poderá utilizar o cliente para fazer requisições ao MemberKit, com base na documentação de integração da API disponível em: https://gist.github.com/rainerborene/26bc6b66bbc5dd4f78a1141df31ef718
Transações
Nesta seção será explicado como utilizar transações da API do MemberKit utilizando o SDK.
Lista todas as assinaturas ativas na área de membros
<?php $test = $mk->membership_levels();
Lista todas as turmas ativas na área de membros
<?php $test = $mk->classrooms();
Lista os membros e respectivas pontuações acumuladas no ranking
<?php $test = $mk->rankings($classrom_id);
Lista as pontuações de um membro específico
<?php $test = $mk->user_ranking($user_id);
Lista feeds de atividades de um membro específico
<?php $test = $mk->user_activities($email);
Lista todos os cursos cadastrados
<?php $test = $mk->courses();
Retorna dados básicos do curso com módulos e respectivas aulas
<?php $test = $mk->course($course_id);
Retorna dados completo de uma aula específica
<?php $test = $mk->lesson($course_id, $lesson_id);
Gera um novo token de autenticação com duração de 1 hora
<?php $test = $mk->token($email);
Cadastrar ou Atualizar um Aluno
Importante: Há três níveis de acesso na Memberkit: matrículas individuais, acesso ilimitado ou assinatura. Ao enviar sua requisição, use apenas uma modalidade de inscrição usando o parâmetro classroom_ids
, unlimited
ou 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);
Adiciona uma nova pontuação
Para adicionar manualmente uma pontuação ao ranking de um aluno.
<?php $test = $mk->scores($user_email, $reason, $value, $course_id);
Remove a pontuação adicionada manualmente
Para remover uma pontuação adicionada manualmente ao ranking de um aluno, você deve passar o mesmo motivo de quando foi adicionada (campo reason).
<?php $test = $mk->delete_scores($user_email, $reason, $course_id);
Marca todas as aulas de um curso como não concluídas
Para marcra todas as aulas de um curso como não concluídas para um aluno em específico.
<?php $test = $mk->delete_lesson_statuses($user_email, $course_id);