Pular para o conteúdo principal

Guia de integração POK + Open edX

Este guia mostra como conectar o Open edX ao POK Proof of Knowledge para que sua plataforma emita credenciais digitais verificáveis automaticamente quando um aluno concluir um curso. Você vai configurar um template de certificado e uma API key no POK, ativar a integração no Django Admin e habilitar os certificados no Open edX Studio.

Parte 1: Configurar a plataforma POK​

Criar ou personalizar um template de certificado​

  1. Acesse seu painel do POK pelo seletor de região.

  2. Abra Visualização.

  3. Crie um novo template ou edite um existente.

  4. Configure os campos obrigatórios padrão:

    • Title
    • Organization Name
    • Achiever

    Também é possível criar campos personalizados opcionais, como nota ou signatário.

  5. Salve o template.

Para mais detalhes sobre como criar templates, consulte Designs.

Importante: copie o Template ID, você vai precisar dele depois no Open edX. Você pode obtê-lo:

  • Pela URL ao editar o template:
.../design/[SEU_TEMPLATE_ID]

Gerar sua API key​

  1. Abra o menu do seu perfil.

  2. Vá para Integrações.

  3. Na lista de plataformas, encontre Open edX e clique em Connect.

  4. Copie a API key gerada e guarde-a com segurança. Esta é a única vez que ela será exibida.

Você vai usá-la na configuração do Open edX assim:

"POK_API_KEY": "sua_api_key_aqui"

Armazenar a API key no Open edX​

  1. Acesse o Django Admin: faça login no seu LMS como superusuário e navegue até https://<seu-dominio-lms>/admin.

  2. Encontre Site Configurations (o nome da seção pode variar conforme a versão do Open edX).

  3. Clique em Add site configuration, ou edite a configuração existente.

  4. Selecione o Site atual no menu suspenso.

  5. No campo Values, insira a chave como uma propriedade JSON. Se o campo estiver vazio, deve ficar assim:

{
  "POK_API_KEY": "sua_api_key_aqui"
}

Se já houver configurações, adicione uma vírgula após a última linha e depois insira a nova chave.

  1. Marque a caixa Enabled.

  2. Clique em Save.

Parte 2: Ativar o POK no Open edX (configuração de administrador)​

Para ativar o POK dentro do Open edX, é preciso habilitar uma feature flag. Essa flag permite que o Open edX se comunique com os serviços do POK.

  1. Acesse o Django Admin em /admin.

  2. Na seção DJANGO WAFFLE, clique em Flags.

  3. Clique em Add flag.

  4. Configure a flag:

    • Name: module_pok.enable (deve ser exatamente igual).
    • Everyone: marque esta caixa para ativar o recurso para todos os usuários imediatamente.
    • Enabled: confirme que esta caixa está marcada.

  5. Clique em Save.

Parte 3: Configurar os certificados do curso no Studio​

Dentro do Open edX Studio:

  1. Crie ou abra um curso.

  2. Monte a estrutura do curso (seções, unidades, aulas).

  3. Vá para Settings → Certificates.

  4. Preencha os dados que serão enviados ao POK:

    • Course title
    • Signatory name
    • Signatory title
    • Organization name

  5. Clique em Activate para ativar os certificados.

Essas informações serão enviadas automaticamente ao POK quando um certificado for solicitado.

Parte 4: Definir o idioma do e-mail do certificado (opcional)​

Em Site Preferences, você pode definir o idioma da plataforma. O idioma configurado ali será usado nos e-mails de certificado enviados pelo POK.

Vários idiomas no POK​

Se sua plataforma usa mais de um idioma:

  1. Acesse o POK.

  2. Vá para a seção Marca.

  3. Clique em Customize na seção Emails.

  4. Em Languages, selecione todos os idiomas desejados, de acordo com os idiomas configurados na sua plataforma Open edX.

  5. Clique em Save.

Parte 5: Configuração técnica, o modelo CertificateTemplate​

No Django Admin, o modelo CertificateTemplate permite configurar por curso:

  • template_id: o template do POK que será usado, criado na Parte 1.

  • emission_type: o método de emissão.

    • Valor POK: credencial básica, gratuita. O aluno pode visualizar e compartilhar a credencial online. Ela fica disponível como imagem hospedada no POK.
    • Valor blockchain: credencial blockchain, paga. Emitida como credencial blockchain NFT, mais segura e permanente. Pode ser visualizada online e no Polygonscan.

  • course_id: o curso vinculado.

Essa estrutura garante que cada curso possa emitir certificados usando as configurações do próprio template.

Sua plataforma Open edX agora está integrada aos certificados digitais do POK. Os alunos podem concluir cursos e receber credenciais profissionais verificáveis automaticamente.

Experiência do aluno​

Solicitar o certificado​

Do ponto de vista do aluno, o processo é simples:

  1. O aluno conclui os requisitos do curso.

  2. Clica em Request Certificate.

  3. O Open edX envia uma requisição ao POK via API e o aluno recebe um e-mail com a credencial gerada.

  4. Após alguns segundos, ele atualiza a página do curso.

  5. O botão View My Certificate aparece e abre o certificado hospedado no POK.

Validação do certificado​

Cada certificado inclui verificação integrada. O aluno pode:

  • Abrir os detalhes do certificado.
  • Clicar em Validate credential. Essa etapa garante a autenticidade e previne fraudes.
  • Confirmar a identidade.
  • Baixar ou compartilhar a credencial com segurança.

Resultado final​

Depois de concluir a configuração:

  • Os certificados são emitidos automaticamente.
  • As credenciais são seguras e verificáveis.
  • Os alunos recebem certificados digitais completos.
  • O sistema permanece modular e fácil de manter.

Saiba mais​

Para saber como as integrações LTI da POK se conectam com o seu LMS e outros sistemas, acesse a página da funcionalidade de integrações com LMS e CRM.