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


1. Retornar uma lista de avaliações de uma determinada aula de um curso 



Com o método acima é possível obter a lista de avaliações de uma determinada aula de um curso que possui na plataforma. 

 

Parâmetros envolvidos:  

Page: Número da página 

Course_slug: Slug do curso 

Auth_token: Token de autenticação 

User_id: Id do usuário 

 

Exemplo de URL: Sua-plataforma.eadbox/api/courses/{cuouse_id}/lectures/{lecture_id}/user_assessments?auth_token= {authentication_token}. 

 

Obs: Neste método, pode ser utilizado o course_slug no lugar do course_id e lecture_slug no lugar do lecture_id. 

Ao acessar o Postman, selecione o método GET e insira o parâmetro conforme o exemplo dado.   



A execução da requisição acima nos retorna um objeto JSON como este, com as informações dos usuários que realizaram a avaliação.  

 

{ 

  "lecture_id": "string",  id da aula  

  "lecture_slug": "string", slug da aula 

  "title": "string", título da aula 

  "description": "string", descrição do curso  

  "is_free": true, se o curso é gratuito 

  "updated_at": "2018-09-20T01:20:43.832Z", data da atualização 

  "created_at": "2018-09-20T01:20:43.832Z", data da criação 

  "percentage_finished": 0, porcentagem de finalização  

  "average_grade": 0, nota média  

  "approved": true, se está aprovado  

} 

 

Caso as informações da requisição não estejam corretas, irá retornar o seguinte erro:

 



 

2. Retornar uma lista de sessões de uma determinada aula de um curso



O método acima pode ser utilizado para obter a lista de sessões de uma determinada aula de um curso. 

 

Parâmetros envolvidos: 

Page: página da sessão 

course_id: Id do curso 

lecture_id: Id da aula 

auth_token: Token de autenticação 

 

Exemplo de URLsua-plataforma.eadbox/api/admin/courses/{course_id}/lectures/{lecture_id}/lecture_visits?auth_token= {authentication_token}.

 

 Ao acessar o Postman, selecione o método GET e insira o parâmetro conforme o exemplo dado.   



A execução da requisição acima nos retorna um objeto JSON como este, com as informações das sessões da aula especificada. 

{ 

  "lecture_visit_id": "string", id da sessão 

  "open": true, se a sessão está aberta 

  "logged_in_ip": "string", ip do login 

  "logged_in_at": "string", data e hora  do login  

  "logged_out_at": "string", data e hora do logout  

  "duration": 0, duração da sessão 

  "user": { informações do usuário 

    "user_id": "string", id do usuário 

    "user_slug": "string", slug do usuário 

    "email": "string", e-mail do usuário 

    "name": "string" nome do usuário 

  } 

} 

 

Caso selecione outro método para esse parâmetro, por exemplo POST, irá retornar uma mensagem de erro similar a esta: 

 


 

 

3. Retornar uma lista de sessões do portal 



Com o método acima é possível obter as informações referente às sessões que possui na plataforma.  

Parâmetros envolvidos: 

Page: página da sessão 

user_id: Id do usuário 

Open: Filtro por sessões ativas 

 

Exemplo de URLsua-plataforma/api/admin/sessions?auth_token={authentication_token} 

Ao acessar o Postman, selecione o método GET e insira o parâmetro conforme o exemplo dado.   



A execução do método acima no retorna um objeto JSON como este, com as informações das sessões de toda a plataforma.  

{ 

  "lecture_visit_id": "string",  Id da sessão 

  "open": true, Status da sessão 

  "logged_in_ip": "string", ip do login 

  "logged_in_at": "string", data e hora do login 

  "logged_out_at": "string", data e hora do logout 

  "duration": 0, duração da sessão 

  "user": { dados do usuário 

    "user_id": "string", id do usuário 

    "user_slug": "string", slug do usuário 

    "email": "string", e-mail do usuário 

    "name": "string", nome do usuário 

  } 

} 


Caso selecione outro método para esse parâmetro, por exemplo POST, irá retornar uma mensagem de erro similar a esta:  



4.Retornar lista de usuários do portal 



Com o método acima é possível obter as informações referente aos usuários que possui na plataforma.  

 

Parâmetros envolvidos: 

Auth_token: Token de autenticação 

Page: Número da página 

E-mail: E-mail do usuário 

User_id: Id do usuário 

Document_id: CPF 

Locked: Se true retorna usuários bloqueados 

Active: Filtro para usuários ativos 

 

Exemplo de URL: sua-plataforma.eadbox/api/admin/users?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este, com as informações de todos os usuários ativos na plataforma.  

{ 

  "user_id": "string", id do usuário 

  "user_slug": "string", slug do usuário 

  "auth_token": "string", Token do usuário 

  "active": true, Se o usuário está ativo 

  "email": "string", E-mail do usuário 

  "name": "string", Nome do usuário 

  "tags": "string",   

  "biography": "string", Biografia do usuário 

  "cover_color": "string",  cor da capa 

  "document_id": "string", documento do usuário 

  "mobile_phone": 0, Telefone celular do usuário 

  "home_phone": 0, Telefone residencial do usuário 

  "profession": "string",  Profissão do usuário 

  "street": "string", Rua do usuário 

  "number": "string", Número da casa do usuário 

  "complement": "string", Complemento do endereço do usuário 

  "neighborhood": "string",  Bairro 

  "zip": "string", CEP do usuário 

  "city": "string", Cidade do usuário 

  "state": "string", Estado do usuário 

  "group": { Dados do grupo do usuário 

    "slug": "string", Slug do grupo 

    "saas_permissions": { Dados da permissão 

      "_id": "string", Id da permissão 

      "extensions": [Dados da extensão  

        "string", Status da extensão 

      ], 

      "name": "string", Nome da extensão 

    } 

  }, 

  "created_at": "2018-09-22T20:16:18.523Z", Data da criação  

  "subscribed_courses_count": 0, Quantidade de cursos assinados  

  "custom_fields": {Dados dos campos customizados 

    "custom_field_example": "string", Exemplo de um campo customizado 

  } 

} 

 

Caso selecione outro método para esse parâmetro, por exemplo POST, irá retornar uma mensagem de erro similar a esta: 




5.Retornaum usuário



Com o método acima é possível obter as informações referente a um usuário especifico que possui na plataforma. Obs: O user_id pode ser obtido pelo método Admin/users. 

 

Parâmetros envolvidos:  
User_id: Id do usuário 

 

Exemplo de URL: sua-plataforma.eadbox.com/api/admin/users/{user_id}?auth_token={authentication_token} 



{ 

  "user_id": "string", id do usuário 

  "user_slug": "string", slug do usuário 

  "auth_token": "string", Token do usuário 

  "active": true, Se o usuário está ativo 

  "email": "string", E-mail do usuário 

  "name": "string", Nome do usuário 

  "tags": "string",   

  "biography": "string", Biografia do usuário 

  "cover_color": "string",  cor da capa 

  "document_id": "string", documento do usuário 

  "mobile_phone": 0, Telefone celular do usuário 

  "home_phone": 0, Telefone residencial do usuário 

  "profession": "string",  Profissão do usuário 

  "street": "string", Rua do usuário 

  "number": "string", Número da casa do usuário 

  "complement": "string", Complemento do endereço do usuário 

  "neighborhood": "string",  Bairro 

  "zip": "string", CEP do usuário 

  "city": "string", Cidade do usuário 

  "state": "string", Estado do usuário 

  "group": { Dados do grupo do usuário 

    "slug": "string", Slug do grupo 

    "saas_permissions": { Dados da permissão 

      "_id": "string", Id da permissão 

      "extensions": [Dados da extensão  

        "string", Status da extensão 

      ], 

      "name": "string", Nome da extensão 

    } 

  }, 

  "created_at": "2018-09-22T20:16:18.523Z", Data da criação  

  "subscribed_courses_count": 0, Quantidade de cursos assinados  

  "custom_fields": {Dados dos campos customizados 

    "custom_field_example": "string", Exemplo de um campo customizado 

  } 

} 

Caso selecione outro método para esse parâmetro, por exemplo POST, irá retornar uma mensagem de erro similar a esta:  



Sendo assim, é muito importante verificar se o método que está utilizando está correto e se os parâmetros estão de acordo com o que está sendo solicitado.  


 

6. Atualizar o cadastro de um usuário no portal 



Com o método acima é possível alterar os dados de cadastro de um usuário via API.  



Parâmetros envolvidos:  

user_id: Id do usuário 

password: Senha 

password_confirmation: Confirmação de senha 

email: Email 

name: Nome 

tags: Lista de intereses do usuário a ser criado.Separado por vírgulas. Ex:tecnologia,educação,aprendizado 

biography: Biografia 

document_id: CPF 

mobile_phone: Telefone Celular 

home_phone: Telefone Fixo 

group: Grupo do Usuário 

avatar: Imagem do usuário a ser criado. É necessário enviar o request como multipart/form-data para utilizar este campo. Vide RFC 2388 para mais informações. 

street: Endereço (rua) 

number: Endereço (número) 

complement: Endereço (complemento) 

neighborhood: Endereço (bairro) 

zip: Endereço (CEP) 

city: Cidade 

state: Estado 

country: País (Código com três letras, de acordo com a ISO-3166-1 alfa-3 [https://pt.wikipedia.org/wiki/ISO_3166-1_alfa-3]) 

profession: Profissão 

auth_token *: Token de autenticação 

 

Exemplo de URL: Sua-plataforma.eadbox.com/api/admin/users/{user_id}?email={novo%40email.com} 



A execução do método acima retorna um objeto JSON como este, confirmando a alteração do cadastro. 

{ 

  "valid": true 

} 

 

Quando realizamos a pesquisa do cadastro do usuário novamente, é possível confirmar que o e-mail foi alterado com sucesso: 



 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

{ 

  "valid": false 

} 

 


7. Bloquear um usuário no portal 



Com o método acima é possível bloquear o cadastro de um usuário especifico que possui na plataforma. 

 

Parâmetros envolvidos: 

user_id *: Id do usuário 

auth_token *: Token de autenticação 

 

Exemplo de URLsua-plataforma.eadbox.com/api/admin/users/{id_user}?auth_token={authentication_token} 



 

A execução do método acima retorna um objeto JSON como este, confirmando o bloqueio do usuário. 

{ 

  "valid": true 

} 

Quando acessar a lista de usuários utilizando o método /admin/users será possível confirmar se o cadastro foi bloqueado. Caso tente acessar o id do usuário que bloqueou, será retornado nenhum valor. 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

 

{ 

  "valid": false 

} 


 

8. Desbloquear um usuário no portal 



Para desbloquear um usuário especifico da plataforma, podemos selecionar o método POST no Postman utilizar o parâmetro /admin/users/{user_id}/unlock. 

 

Parâmetros envolvidos: 

user_id *: Id do usuário 

auth_token *: Token de autenticação 

 

Exemplo de URL: sua-plataforma/admin/users/{user_id}/unlock?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este, confirmando o desbloqueio do usuário na plataforma. 

{ 

  "valid": true 

} 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

 

{ 

  "valid": false 

} 

 

Ao utilizar o método GET e o parâmetro /admin/users/{user_id}:  



É possível visualizar os dados do usuário novamente:  



 

09. Retornar uma lista de assinaturas de cursos do portal 



om o método acima é possível obter as informações referente todas as assinaturas da plataforma. 

Parâmetros envolvidos:  

user_id *: Id do usuário 

auth_token *: Token de autenticação 

 

Exemplo de URLsua-plataforma.eadbox.com/admin/subscriptions?auth_token={authentication_token} 



 

A execução do método acima retorna um objeto JSON como este abaixo, com todas as informações das assinaturas dos usuários: 

{ 

  "subscription_id": "string", Id da assinatura 

  "paid_and_valid": true, Status do pagamento da assinatura 

  "percentage_finished": 0, Porcentagem do progresso  

  "average_grade": 0, Nota média 

  "finished": true, Status da conclusão  

  "approved": true, Status da aprovação 

  "created_at": "2018-09-23T02:10:02.922Z", Data da criação da assinatura 

  "finished_at": "2018-09-23T02:10:02.922Z", Data da finalização 

  "started_at": "2018-09-23T02:10:02.922Z", Data de inicio  

  "expires_at": "2018-09-23T02:10:02.922Z", Data de expiração  

  "current_payment": true,  Status do pagamento atual 

  "course": { Informações do curso 

    "course_id": "string", Ido curso 

    "course_slug": "string", Slug do curso 

    "title": "string", Título do curso 

  }, 

  "user": { Informações do usuário 

    "user_id": "string", Id do usuário 

    "user_slug": "string", Slug do usuário 

    "email": "string", E-mail do usuário 

    "name": "string" Nome do usuário 

  } 

} 

 

Caso selecione outro método para esse parâmetro, por exemplo POST, ou algum dos dados estejam incorretos irá retornar uma mensagem de erro similar a esta:  



 

 

10. Retornar uma Assinatura 



Com o método acima é possível obter as informações referente uma assinatura especifica.  

 

Parâmetros envolvidos: 

auth_token *: Token de autenticação 

user_id *: Id do usuário 

subscription_id *: Id da Subscription 

 

Exemplo de URLsua-plataforma.eadbox.com/api/admin/subscriptions/{subscription_id}?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este abaixo, com todas as informações da assinatura especificada: 

   { 

  "subscription_id": "string", Id da assinatura 

  "paid_and_valid": true, Status do pagamento da assinatura 

  "percentage_finished": 0, Porcentagem do progresso  

  "average_grade": 0, Nota média 

  "finished": true, Status da conclusão  

  "approved": true, Status da aprovação 

  "created_at": "2018-09-23T02:10:02.922Z", Data da criação da assinatura 

  "finished_at": "2018-09-23T02:10:02.922Z", Data da finalização 

  "started_at": "2018-09-23T02:10:02.922Z", Data de inicio  

  "expires_at": "2018-09-23T02:10:02.922Z", Data de expiração  

  "current_payment": true,  Status do pagamento atual 

  "course": { Informações do curso 

    "course_id": "string", Ido curso 

    "course_slug": "string", Slug do curso 

    "title": "string", Título do curso 

  }, 

  "user": { Informações do usuário 

    "user_id": "string", Id do usuário 

    "user_slug": "string", Slug do usuário 

    "email": "string", E-mail do usuário 

    "name": "string" Nome do usuário 

  } 

} 

 

} 

 

Caso selecione outro método para esse parâmetro, por exemplo POST, ou algum dos dados estejam incorretos irá retornar uma mensagem de erro similar a esta:  



 

11. Bloquear a assinatura de um usuário 



Com o método acima é possível bloquear a assinatura de um ou mais usuários da plataforma. 

 

Parâmetros envolvidos: 

subscription_id *: Id da Assinatura 

auth_token *: Token de autenticação 

 

Exemplo: sua-plataforma.eadbox.com/api/admin/subscriptions/{subscription_id}?auth_token={authentication_token}. 



A execução do método acima retorna um objeto JSON como este, confirmando o bloqueio da assinatura. 

{ 

  "valid": true 

} 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

 

{ 

  "valid": false 

} 

 

Quando acessar a lista de assinaturas utilizando o método /admin/subscriptions será possível confirmar se a assinatura foi bloqueada. Caso tente acessar o id da assinatura que bloqueou, será retornado nenhum valor. 



12.Desbloquear a assinatura de um usuário 



Com o método acima é possível desbloquear uma assinatura de um usuário da plataforma. 

 

Parâmetros envolvidos: 

subscription_id *: Id da Assinatura 

auth_token *: Token de autenticação 

 

Exemplo: sua-plataforma.eadbox.com/api/admin/subscriptions/{subscriptions_id}/unlock?auth_token={authentication_token} 



 

A execução do método acima retorna um objeto JSON como este, validando que o usuário foi desbloqueado: 

{ 

  "valid": true 

} 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

 

{ 

  "valid": false 

} 

 

Quando acessar a lista de assinaturas utilizando o método /admin/subscriptions será possível confirmar se a assinatura foi desbloqueada.  

 


13.Bloquear um pagamento na plataforma  



Com o método acima é possível bloquear um pagamento de um usuário da plataforma.  

 

Parâmetros envolvidos:  

subscription_id *: Id da Subscription 

auth_token *: Token de autenticação 

 

Exemplo de URLsua-plataforma.eadbox.com/api/admin/payments/{payment_id}?auth_token={authentication} 



A execução do método acima retorna um objeto JSON como este, confirmando o bloqueio do pagamento. 

{ 

  "valid": true 

} 

 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

{ 

  "valid": false 

} 

 

Quando acessar a lista de assinaturas utilizando o método /admin/payments será possível confirmar se a assinatura foi bloqueada. Caso tente acessar o id da assinatura que bloqueou, será retornado nenhum valor. 



14. Listar as salas de aula da plataforma 



Com o método acima é possível obter as informações referente as salas de aulas da plataforma. 

 

Parâmetros envolvidos: 

page: Número da página 

auth_token *: Token de autenticação 

user_id: Filtro retorna salas de aula em que usuário está matriculado 

 

Exemplo de URLsua-plataforma.eadbox.com/api/admin/teams?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este, com as informações das salas de aula: 

{ 

  "team_id": "string", Id da sala de aula 

  "name": "string", Nome da sala de aula 

  "course": { Informações do curso 

    "course_id": "string", Id do curso 

    "course_slug": "string", Slug do curso 

    "title": "string" Titulo de curso 

  }, 

  "user": { Informações do usuário 

    "user_id": "string", Id do usuário 

    "user_slug": "string", Slug do usuário 

    "email": "string", E-mail do usuário 

    "name": "string" Nome do usuário 

  } 

} 

 

Caso selecione outro método para esse parâmetro, por exemplo POST, ou algum dos dados estejam incorretos irá retornar uma mensagem de erro similar a esta: 



 


15. Criar uma sala de aula na plataforma 



Com o método acima é possível criar uma sala de aula na plataforma. 

 

Parâmetros envolvidos:  

name *: Nome da sala de aula 

user_ids *: Ids dos usuários 

email *: Email dos usuários 

course_ids *: Ids dos cursos separados por vírgulas 

course_slugs *: Slugs dos cursos separados por vírgulas 

auth_token *: Token de autenticação 

 

Exemplo de URL: sua-plataforma.eadbox.com/api/admin/teams?name={nome_da_ sala}&user_ids={user_ids}&email={email_dos_usuarios}&course_ids={course_id}&course_slugs={course_slugs} 



A execução do método acima retorna um objeto JSON como este, confirmando a criação da sala de aula: 

{ 

  "course": {  

    "team_id": "string", Id da Sala de aula 

    "name": "string" Nome da sala de aula 

  }, 

  "valid": true 

} 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

{ 

  "valid": false 

} 

Quando acessar a lista de salas de aula utilizando o parâmetro /admin/teams  e o método GET, será possível confirmar se a assinatura foi bloqueada. Caso tente acessar o id da assinatura que bloqueou, será retornado nenhum valor. 



16. Retornar uma sala de aula 



Com o método acima é possível obter as informações referente a uma sala de aula especifica da plataforma.  

 

Parâmetros envolvidos: 

auth_token *: Token de autenticação 

user_id *: Id do usuário 

team_id *: Id da sala de aula 

 

Exemplo de URLsua-plataforma.eadbox.com/api/admin/teams/{team_id}?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este, com as informações da sala de aula especificada: 


{ 

  "team_id": "string", Id da sala de aula 

  "name": "string", Nome da sala de aula 

  "course": { Informações do curso 

    "course_id": "string", Id do curso 

    "course_slug": "string", Slug do curso 

    "title": "string" Titulo de curso 

  }, 

  "user": { Informações do usuário 

    "user_id": "string", Id do usuário 

    "user_slug": "string", Slug do usuário 

    "email": "string", E-mail do usuário 

    "name": "string" Nome do usuário 

  } 

}

 

Caso selecione outro método para esse parâmetro, por exemplo POST, ou algum dos dados estejam incorretos irá retornar uma mensagem de erro similar a esta: 



 


17. Editar uma sala de aula da plataforma



Com o método acima é possível editar uma sala de aula da plataforma.  

 

Parâmetros envolvidos: 

team_id *: Id da sala de aula 

name *: Nome da sala de aula 

user_ids *: Ids dos usuários separados por vírgulas 

email *: Email dos usuários 

course_ids *: Ids dos cursos sepados por vírgulas 

course_slugs *: Slugs dos cursos sepados por vírgulas 

auth_token *: Token de autenticação 


Exemplo de URL editando o nome da sala: sua-plataforma.eadbox.com/api/admin/teams 
/{team_id}?name=Teste&user_ids={user_ids}&email=novo%40email.com 
&course_ids={course_ids}&course_slugs=customer-success-eadbox 



A execução do método acima retorna um objeto JSON como este, confirmando as alterações na sala. 

{ 

  "valid": true 

} 

 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

{ 

  "valid": false 

} 

Ao puxarmos a sala de aula pelo parâmetro /admin/teams/{teams_id}  e o método GET é possível confirmar que a sala foi alterada.  



18. Adicionar um ou mais usuários a sala de aula 



Com o método acima é possível adicionar um ou mais alunos em uma sala de aula da plataforma. 

 

Parâmetro envolvidos: 

team_id *: Nome da sala de aula 

user_ids *: Ids dos usuários separados por vírgula 

email *: Email dos usuários 

 

Exemplo de URLsua-plataforma.eadbox.com/api/admin/teams/{teams_id}/users?user_ids={user_ids}&
email=admin1%40admin.com 



A execução do método acima retorna um objeto JSON como este, confirmando que o usuário foi incluso na sala. 

{ 

  "valid": true 

} 

 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

{ 

  "valid": false 

} 

 

 Ao puxarmos a sala de aula pelo parâmetro /admin/teams/{teams_id} é possível confirmar que a sala possui um novo usuário. 



19. Remover um ou mais usuários a sala de aula 



Com o método acima é possível remover um aluno de uma sala de aula. 

Obs: Nessa requisição devem ser utilizados ou os user_ids ou os user_emails. 

 

Parâmetros envolvidos:  

team_id *: Nome da sala de aula 

user_ids *: Ids dos usuários 

email *: Email dos usuários 

 

Exemplo de URLsua-plataforma.eadbox.com/api/admin/teams/{team_id}/users/user_id?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este, confirmando a remoção do aluno. 

{ 

  "valid": true 

} 

 

Caso os dados do parâmetro estejam incorretos irá retornar a seguinte mensagem: 

{ 

  "valid": false 

} 

 

Quando acessar a sala de aula utilizando o método /admin/teams/{team_idserá possível confirmar se o usuário foi removido.  

Sendo assim, é muito importante verificar se o método que está utilizando está correto e se os parâmetros estão de acordo com o que está sendo solicitado. 



 20. Retornar a lista das trilhas disponíveis no portal 



Com o método acima é possível obter as informações referente as trilhas da plataforma. 

 

Parâmetros eventuais: 

page: Número da página 

auth_token *: Token de autenticação 

 

Exemplo: sua-plataforma.eadbox.com/api/admin/tracks?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este, com as informações das trilhas: 

{ 

  "track_id": "string", Id da trilha 

  "track_slug": "string", Slug da trilha 

  "title": "string", Titulo da trilha 

  "description": "string", Descrição da trilha 

  "published": true, Status de publicação da trilha 

  "courses": [ Informações dos cursos que possuem na trilha 

    { 

      "course_id": "string", Id do curso  

      "course_slug": "string", Slug do curso  

      "title": "string", Titulo do curso 

      "description": "string", Descrição do curso 

      "is_paid": true, Se o curso é pago ou não 

      "price": 0,  Preço do curso 

      "published": true, Status de publicação do curso 

      "logo_url": "string", URL da logo do curso 

      "listed": true, Status de listagem do curso 

    } 

  ], 

  "logo_url": "string" URL da logo da trilha 

} 

Caso selecione outro método para esse parâmetro, por exemplo POST, irá retornar uma mensagem de erro similar a esta:  




21.Retornar uma trilha 



Com o método acima é possível obter as informações referente a uma trilha especifica da plataforma. 

 

Parâmetros envolvidos: 

auth_token *: Token de autenticação 

track_id *: Id da trilha 

 

Exemplo: sua-plataforma.eadbox.com/api/admin/tracks/{track_id}?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este, com as informações da trilha especifica: 

{ 

  "track_id": "string", Id da trilha 

  "track_slug": "string", Slug da trilha 

  "title": "string", Titulo da trilha 

  "description": "string", Descrição da trilha 

  "published": true, Status de publicação da trilha 

  "courses": [ Informações dos cursos que possuem na trilha 

    { 

      "course_id": "string", Id do curso  

      "course_slug": "string", Slug do curso  

      "title": "string", Titulo do curso 

      "description": "string", Descrição do curso 

      "is_paid": true, Se o curso é pago ou não 

      "price": 0,  Preço do curso 

      "published": true, Status de publicação do curso 

      "logo_url": "string", URL da logo do curso 

      "listed": true, Status de listagem do curso 

    } 

  ], 

  "logo_url": "string" URL da logo da trilha 

} 

Caso selecione outro método para esse parâmetro, por exemplo POST, irá retornar uma mensagem de erro similar a esta:  



 

22.Retornando uma lista de assinaturas de um aluno do portal 



Com o método acima é possível obter as informações referente as assinaturas de um usuário especifico. 

Parâmetros envolvidos: 

user_id *: Id do usuário 

auth_token *: Token de autenticação 

 

Exemplo: sua-plataforma.eadbox.com/api/admin/users/{user_id}/subscriptions?auth_token={authentication_token} 



A execução do método acima retorna um objeto JSON como este abaixo, com todas as informações das assinaturas do usuário: 

{ 

  "subscription_id": "string", Id da assinatura 

  "paid_and_valid": true, Status do pagamento 

  "percentage_finished": 0, Porcentagem do progresso  

  "average_grade": 0, Nota média 

  "finished": true, Status de finalização  

  "approved": true, Status de aprovação  

  "created_at": "2018-09-24T00:24:51.682Z", Data da criação 

  "finished_at": "2018-09-24T00:24:51.682Z", Data da finalização 

  "started_at": "2018-09-24T00:24:51.682Z", Data de inicio 

  "expires_at": "2018-09-24T00:24:51.682Z", Data de expiração 

  "current_payment": true, Status do pagamento atual  

  "course": {Informações do curso 

    "course_id": "string", Id do curso 

    "course_slug": "string", Slug do curso 

    "title": "string", Titulo do curso 

  }, 

  "user": {Informações do usuário 

    "user_id": "string", Id do usuário 

    "user_slug": "string", Slug do usuário 

    "email": "string", E-mail do usuário 

    "name": "string" Nome do usuário 

  } 

} 

    Caso selecione outro método para esse parâmetro, por exemplo POST, irá retornar uma mensagem de erro similar a esta:  




 

     Caso ainda tenha ficado alguma dúvida, entre em contato com a nossa equipe de atendimento através do suporte@eadbox.com