Skip to main content

POK + Open edX Integration Guide

This guide shows you how to connect Open edX to POK Proof of Knowledge so your platform issues verifiable digital credentials automatically when learners complete a course. You will configure a certificate template and API key in POK, enable the integration in Django Admin, and set up certificates in Open edX Studio.

Part 1: Configure the POK platform​

Create or customize a certificate template​

  1. Log in to your POK dashboard through the region selector.

  2. Open Designs.

  3. Create a new template or edit an existing one.

  4. Set the default required attributes:

    • Title
    • Organization Name
    • Achiever

    You can also add optional custom attributes, such as grade or signatory.

  5. Save your template.

For more detail on building templates, see Designs.

Generate your API key​

  1. Open your profile menu.

  2. Go to Integrations.

  3. In the platform list, find OPEN edX and click Connect.

  4. Copy the generated API key and store it safely. This is the only time it will be visible.

You will use it later in your Open edX configuration as:

"POK_API_KEY": "your_api_key_here"

Store the API key in Open edX​

  1. Access Django Admin: log in to your LMS as a superuser and navigate to https://<your-lms-domain>/admin.

  2. Find site configurations: locate the Self_Paced or Site_Configuration section (the exact name may vary by Open edX version) and click Site configurations.

  3. Add or edit the configuration:

    • Click Add site configuration, or select your existing site to edit it.
    • Select your current Site from the dropdown menu.

  4. Insert the API key: in the Values field, enter your key as a JSON property. If the field is empty, it should look like this:

{
    "POK_API_KEY": "your_api_key_here"
}

If there are existing settings, add a comma after the last one and then add your new key.

  1. Enable and save: make sure the Enabled checkbox is selected and click Save.

Part 2: Enable POK in Open edX (admin setup)​

To activate POK inside Open edX, you need to enable a feature flag. This flag allows Open edX to communicate with POK services.

  1. Access Django Admin: log in to your Open edX instance as a staff user or superuser and navigate to /admin.

  2. Locate Waffle flags: under the DJANGO-WAFFLE section, click Flags.

  3. Click Add flag (top right).

  4. Configure the flag:

    • Name: module_pok.enable (must match exactly).
    • Everyone: check this box to enable the feature for all users immediately.
    • Enabled: make sure this checkbox is checked.

  5. Click Save.

Part 3: Configure course certificates in Studio​

Inside Open edX Studio:

  1. Create or open a course.

  2. Build your course structure (sections, units, lessons).

  3. Go to Settings → Certificates.

  4. Fill in the data that will be sent to POK in the certificate payload:

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

  5. Click Activate to enable certificates.

This information is sent to POK automatically when a certificate is requested.

Part 4: Set the certificate email language (optional)​

In Site Preferences, you can define the platform language. The language selected there determines the language of the certificate emails sent by POK.

Multiple languages in POK​

If your platform uses more than one language, go to POK:

  1. Find the Branding section.

  2. Click Customize in the Emails section.

  3. In the Languages box, select every translation you want to support, based on the languages configured on your Open edX platform, then click Save.

Part 5: Technical configuration, the CertificateTemplate model​

In Django Admin, the CertificateTemplate model allows course-level configuration of:

  • template_id: the POK template to use, created in Part 1.

  • emission_type: the issuance method.

    • Value POK: basic credential, free. Recipients can view and share their credential on the web at no cost. It is an image available from the POK website.
    • Value blockchain: blockchain credential, paid. Recipients receive their credential issued as a blockchain NFT credential, more secure and permanent. It can be viewed on the web and on Polygonscan.

  • course_id: the linked course.

This structure ensures each course can issue certificates using its own template settings.

Your Open edX platform is now integrated with POK digital certificates. Learners can complete courses and instantly receive professional, verifiable credentials.

Learner experience​

Request a credential from a course​

From the learner's perspective, the process is simple:

  1. The student completes the course requirements.

  2. The student clicks Request Certificate.

  3. Open edX sends a request to POK via the API, and the student receives an email with the generated credential.

Email received by the student with the issued credential

  1. After a few seconds, the student refreshes the course page.

  2. A View My Certificate button appears. It opens the certificate hosted by POK.

Certificate validation​

Each certificate includes built-in verification. Learners can:

  • Open the certificate details.
  • Click Validate credential. This verification step ensures authenticity and prevents fraud.
  • Confirm their identity.
  • Download or share the credential securely.

Final result​

After completing this setup:

  • Certificates are issued automatically.
  • Credentials are secure and verifiable.
  • Learners receive rich digital certificates.
  • The system remains modular and easy to maintain.

Learn more​

To see how POK's LTI integrations connect with your LMS and other systems, check out the LMS and CRM integrations feature page.