Integrações
      Voltar para o início
      1. Centro de ajuda
      2. EngagED Sales
      3. Integrações

      Como integrar o Moodle com a EngagED Sales? (configurações iniciais)

      Siga este passo-a-passo para configurar seu ambiente Moodle para permitir a integração com a EngagED Sales

      Para utilizar o EngagED Sales como ambiente de inscrição e vendas, integrado ao seu ambiente Moodle (para entrega de conteúdo online), siga as orientações abaixo para configurar seu ambiente.

      1 - Configurações Web Service Moodle

       

      Algumas orientações deste passo a passo podem variar levemente em seu ambiente Moodle, à depender do idioma que estiver utilizando, e da versão do Moodle instalada em seu servidor.

      1. Acesse seu ambiente administrativo no Moodle;
      2. Navegue até “Site administration”;


      3. Acesse a aba “Plugins”;


      4. Na seção “Web services”, clique em “Overview”;


      5. Irá abrir uma lista similar à esta, que listará todos os procedimentos que precisará realizar em seu ambiente Moodle para habilitar a função “Web Service” e assim poder integrar ao ambiente EngagED Sales: 

      Este passo a passo parte do princípio de que nenhuma das configurações abaixo tenham sido realizadas em seu ambiente até o momento.

      Caso alguma das configurações desta lista já tenha sido realizada em seu ambiente, basta seguir para o próximo step de configuração.

       

      1.1 - Enable web services

       

      1. Clique com o botão direito em “Enable web services”, e abra em uma nova aba;

      Durante a configuração de cada step, sempre abriremos em outra aba, para voltar de forma prática no processo de configuração dos steps até o final do procedimento.

       

      2. Na aba aberta, habilite o check-box “Enable web services”, em seguida clique em “Save changes”;

       

      3. Feche esta aba e retorne para a lista anterior de steps;

       

      1.2 - Enable protocols

       

      1. Abra em uma nova aba a configuração “Enable protocols”;

      2. A EngagED utiliza o protocolo “REST” para comunicação com o Moodle. Caso a configuração esteja com um ícone de olho riscado (desabilitado), clique sobre o ícone de forma a habilitar esta configuração (olho preenchido);

      3. Clique em “Save changes”, aguarde a mudança ser aplicada, em seguida feche a aba e retorne para a lista anterior;

       

      1.3 - Create a specific user

       

      Aqui iremos criar um usuário que será utilizado para a EngagED realizar as operações de cadastramento de novos usuários, e inscrições (enrolments em novos cursos):

      1. Abra em uma nova aba a configuração “Create a specific user”;

         

      2. Preencha os campos:
        1. Username: engaged;
        2. New password: senha que satisfaça as regras de segurança especificadas pelo Moodle;
        3. First name: EngagED
        4. Surname: API
        5. Email address: dev@engaged.com.br;



      3. Clique em “Create user”, aguarde a criação, em seguida feche a aba e retorne para a lista anterior;

       

      1.4 - Check user capability

       

      Neste passo checaremos as capacidades, para verificar se o usuário recém criado possui permissão para realizar os procedimentos da integração.

       

      Como ainda não associamos nenhuma permissão ao usuário recém criado, então neste passo estaremos criando um role (permissão) que tenham as permissões necessárias.

       

      1. Abra em uma nova aba a configuração “Check user capability”;

      2. Navegue até “Site administration” > “Users” > “Define roles”;

      3. Com a lista de permissões aberta, criaremos uma nova, portanto clique em “Add a new role”;

      4. Mantenha a primeira opção em “No role”, e clique em “Continue”;

      5. Preencha os campos:

        1. Short name: engaged;
        2. Custom full name: EngagED API;

      6. Habilite a opção “System” na seção “Context types where this role may be assigned”

      7. Em "Allow role assignments", selecione a opção "Student";


      8. Na lista de permissões adicione as seguintes permissões:

        1. webservice/rest:use

        2. moodle/user:viewalldetails

        3. moodle/site:viewuseridentity

        4. moodle/role:assign

          Exemplo de como adicionar uma permissão no gif abaixo (faça isso para as 4 permissões, e não apenas para a webservice/rest:use como no gif abaixo)

      9. Após adicionar as 4 permissões, clique em "Create this role";
         

      10. Revise as configurações acima para se certificar de que o role foi configurado corretamente, feche a aba e retorne para a lista anterior;

       

      1.5 - Select a device

       

      Neste passo iremos criar um serviço.

      1. Abra “Select a device” em uma nova aba;

      2. Clique em “Add”;

      3. Preencha os campos:

        1. Name: EngagED Service

        2. Short name: engaged

        3. Habilite o campo “Enabled”;

        4. Habilite o campo “Authorised users only”;

           

      4. Após preencher os campos corretamente, clique em “Add service”;

      5. O próximo passo é adicionar funções, que coincidentemente já é o próximo passo da lista de steps que precisamos seguir. Já iremos aproveitar para realizar este procedimento!

       

      1.6 - Add functions

       

      Neste passo iremos adicionar as funções que a EngagED precisará utilizar via API com o Moodle para operacionalizar a integração corretamente.

       

      1. Clique em “Add functions”;


      2. No campo “Search”, adicione as seguintes funções que o serviço da EngagED necessita:


      Função Finalidade
      core_course_get_courses Função para listar os cursos disponíveis no Moodle.
      core_user_create_users Função que cria novos usuários no Moodle.
      core_user_get_users Função que lista os usuários existentes no Moodle.
      enrol_manual_enrol_users Função que permite inscrever usuários em um curso do Moodle.



      3. Verifique se as 4 funções foram adicionadas corretamente, em seguida clique em “Add functions”;

      4. Mantenha esta lista de funções adicionadas aberta, pois o próximo passo da lista de steps é a seleção de um usuário específico para consumir estas permissões;

      1.7 - Select a specific user

      Com a lista de funções adicionadas anteriormente ainda aberta, iremos adicionar um usuário específico para consumir estas funções:

      1. Clique em “External services”;

      2. Na linha do serviço que recém criamos (EngagED Service), clique em “Authorised users”;

      3. Selecione o usuário que criamos anteriormente (dev@engaged.com.br), e clique em “Add”;

      4. Será exibido uma lista de permissões que ainda precisaremos adicionar para este usuário. Mantenha esta aba aberta, pois será uma fonte de consulta para copiar e colar cada uma das permissões listadas:

      5. Abra “Site administration” em uma nova aba;

      6. Clique na aba “Users”;

      7. Clique em “Define roles” na seção “Permissions”;

      8. Clique em “EngagED API”;

      9. Clique em “Edit”;

      10. Copie e cole cada uma das permissões (capabilities) que foram listadas;

      11. Após adicionar todas as permissões, clique “Save changes”;

      12. Certifique-se de que todas as permissões foram adicionadas;

      13. Clique em “Site administration”;

      14. Clique em “Users”, em seguida “Assign system roles”;

      15. Selecione o role “EngagED API”;

      16. Selecione o usuário “EngagED API”, em seguida clique em “Add”;

      17. Após ter associado o usuário, vamos checar se agora o usuário possui todas as permissões. Para isso volte até lá seguindo o passo a passo:

        1. Clique em “Site administration”;

        2. Abra a aba “Plugins”;

        3. Na seção “Web Services” clique em “External services”;

        4. Na linha “EngagED Service” clique em “Authorised users”;

      18. Certifique-se de que a lista de permissões faltantes que antes aparecia, agora não aparecem mais. Caso contrário, repita o passo a passo de associação de permissões;

      19. Após garantir de que todas as permissões foram associadas volte à lista de steps para continuarmos as configurações;

       

      1.8 - Create a token for a user

       

      1. Abra em uma nova aba a configuração “Create a token for a user”;

      2. Selecione os campos com os seguintes valores:

        1. User: EngagED API;
        2. Service: EngagED Service;
        3. mantenha os demais preenchidos como está;

      3. Clique em “Save changes”

      4. Copie o token obtido para o usuário EngagED API, e informe à seu gerente de contas para que possamos realizar a integração de sua conta EngagED Sales com seu ambiente Moodle;

      2 - E agora, qual o próximo passo?

      Após todas estas configurações realizadas, basta informar ao seu gerente de contas as seguintes variáveis obtidas:

      • Seu domínio principal do moodle;
      • Token de autorização gerado a partir dos procedimentos seguidos no passo a passo acima;
      • student_role_id : permissão atribuída para o usuário aluno (por padrão é 5);
      • (opcional) ID dos cursos que deseja referenciar no Moodle, que gostaria de referenciar na EngagED, desta forma, todo aluno inscrito/matriculado nos cursos da EngagED, automaticamente são espelhados para o curso equivalente no ambiente Moodle;

      Depois de enviar estes dados para seu gerente de contas, aguarde a ativação da integração entre seu ambiente EngagED Sales com seu ambiente Moodle (seu gerente de conta irá lhe avisar disso).

      Nesse meio tempo configure seus cursos e turmas na EngagED Sales, além de configurar também seus cursos no Moodle, pois assim que sua conta estiver integrada na EngagED, você precisará integrar os cursos da EngagED com os cursos do Moodle, e para isso, precisará tê-los criado!