Métodos de usuário - API

Atenção: Esse artigo é para os administradores da plataforma. Caso você seja um aluno, favor entrar em contato diretamente com a instituição responsável pelo seu curso.

Os métodos "GET", podem ser feitos no seu navegador ou em ferramentas que tratam de desenvolvimento de API. Já os métodos "POST" e "PUT", não são possível de executar em seu navegador, somente em ferramentas próprias, como por exemplo o POSTMAN.

1. Retorno de matrículas na plataforma

Essa requisição retorna a lista de cursos que os usuários possuem matrícula, junto ao seu estado atual. Para requisitar, basta usar a URL modelo, onde as informações da cor vermelha e em negrito, devem ser substituídas pelas informações de seu acesso:

http://sua-plataforma.eadbox.com/api/user/subscriptions?auth_token=YknengzJKLigJ1L9AzgS

Caso queira acessar as matrículas de um aluno em específico, basta incluir na URL o "user_id", da seguinte forma:

http://sua-plataforma.eadbox.com/api/user/subscriptions?auth_token=YknengzJKLigJ1L9AzgS&user_id=5ad87s9d42d1

2. Adição de matrículas na plataforma

Essa requisição adiciona um curso a um usuário em específico. Para requisitar, basta usar a URL modelo, onde as informações da cor vermelha e em negrito, devem ser substituídas pelas informações de seu acesso:

3. Retorno das aulas disponíveis dos cursos

Essa requisição retorna a lista de aulas disponíveis para os aluno logado num curso. É obrigatório ter a ciência do slug do curso. Para requisitar, basta usar a URL modelo, onde as informações da cor vermelha e em negrito, devem ser substituídas pelas informações de seu acesso:

https://sua-plataforma.eadbox.com/api/user/subscriptions/{course_slug}/lectures?auth_token=LuSaxfQsiz5o4WVV5c1k

Caso queira adicionar uma matrícula para um aluno em específico, basta incluir na URL o "user_id", da seguinte forma:

https://sua-plataforma.eadbox.com/api/user/subscriptions/{course_slug}/lectures?auth_token=LuSaxfQsiz5o4WVV5c1k&user_id=5ad151s58d145

4. Retorno dos conteúdos e seus estados de visualização num determinado curso

Essa requisição retorna a lista dos conteúdos e seus estados de visualização de uma aula de um aluno logado num determinado curso. É obrigatório ter ciência do slug do curso e da aula. Para requisitar, basta usar a URL modelo, onde as informações da cor vermelha e em negrito, devem ser substituídas pelas informações de seu acesso:

https://sua-plataforma.eadbox.com/api/user/subscriptions/{slug-do-curso}/lectures/{slug-da-aula}/contents?auth_token=a4-6BaSRRD7zKHkjXs8R

5. Deixar conteúdo como visualizado

Essa requisição marca um determinado conteúdo como visualizado para um determinado aluno. Para este método, é obrigatório ter os seguintes dados: slug do curso e da aula, ID do conteúdo, e ID do usuário. Para requisitar, basta usar a URL modelo, onde as informações da cor vermelha e em negrito, devem ser substituídas pelas informações de seu acesso:

https://sua-plataforma.eadbox.com/api/user/subscriptions/{slug-do-curso}/lectures/{slug-da-aula}/contents/{id-conteudo}?auth_token=a4-6BaSRRD7zKHkjXs8R&user_id=5a4-6BaSRRD7zKHkjXs8R

Para mais informações a respeito de nossa API, você visitar nossa documentação completa de todos os métodos e requisições, que se encontra em api.eadbox.com.