Skip to main content

​
Before you start

You’ll need:
  • An Edpire account. Sign up free if you do not have one.
  • No pre-existing assessments required. You will create one in this guide

​
Step 1. Sign in and create an assessment

  1. Go to https://edpire.com
  2. Sign in, or sign up and create your organization
  3. Navigate to My Assessments
  4. Click Create assessment

​
Step 2. Add a simple question

Create the simplest possible working example:
  1. Add a question
  2. Enter a prompt (e.g., “What is 2 + 2?”)
  3. Go to the Choices tab
  4. Add multiple options
  5. Mark the correct answer
You can enhance questions later using Blanks, images, or multiple exercises, but keep it simple for now.
Use the preview panel on the left to test your question instantly.

​
Step 3. Publish and share

  1. Click Publish
  2. Copy the share link
Example:
Parameters:
  • {shareCode}: unique identifier for the assessment
  • learner_ref: your internal user ID (recommended). Without it, the learner first sees a short form asking their name and, optionally, an email for their results.
Open the link in a new tab, complete the assessment, and submit your answers.
This share link is the fastest way to prove the engine works end to end, and it is the right mechanism for a teacher pasting an assessment into an LMS or an email. It is not the shape you want for a platform integration, because it takes the learner out of your product. Once this loop works, move to the Embedded Player, which reuses the same learner_ref and the same webhooks, so nothing you do here is wasted.

​
Step 4. Create an API key

  1. In Edpire, open Settings, then the Integrations tab (https://edpire.com/org/settings?tab=integrations)
  2. Under API keys, name the key (e.g., Quickstart Key)
  3. Select the read:assessments and read:results scopes
  4. Click Generate key
  5. Copy and store it securely
Your API key is shown only once. Store it in an environment variable immediately.

​
Step 5. Verify the API

List your assessments:
You should see the assessment you just created.

​
Step 6. Fetch results

Retrieve results for your assessment:
This returns submissions, scores, and learner references.

​
What you’ve done

  • Created an assessment
  • Shared it with a learner
  • Submitted a response
  • Retrieved results via API
You now have a complete end-to-end integration.

​
What’s next?

  • Store assessment IDs and learner_ref in your system
  • Build dashboards or analytics on top of results
  • Explore advanced integrations like webhooks or SDK components