Back to Integrations
API Documentation

PaperScorer Core API

Complete API documentation for integrating PaperScorer's advanced printing, scanning, and scoring capabilities into your learning management or assessment platform.

Contact Integration TeamRequest a Demo

Overview

The PaperScorer Core API enables institutions and platforms to integrate advanced printing and scanning capabilities for assessment management. This API provides endpoints for authentication, answer sheet generation, scan processing, score retrieval, and error resolution.

Base URL

https://api.paperscorer.com
View Full API Documentation

Integration Workflow

Follow these steps to integrate PaperScorer into your platform

1

Authentication

The integration process begins with API partner authentication. Your system will first authenticate using an oAuthToken, followed by educator login through the userLogin endpoint.

  • If this is the first time the educator has logged into PaperScorer, we will automatically create a new account for them.
  • Session information is returned for use in subsequent API calls.

Relevant Endpoints

oAuth Token/oauth/token
User Log In/rest/googleApi/userLogin
Authentication flow diagram
2

Answer Sheet Creation

Educators generate customized bubble sheets from assessment data. The system dynamically generates the answer sheets based on the JSON data provided.

  • A unique URL is returned to a PDF file which can be printed and distributed to students.
  • Each answer sheet includes a unique Form ID for later score retrieval.

Relevant Endpoints

Save Task/rest/ps/saveTask
Answer Sheet Creation flow diagram
3

Scanning & Processing

Students complete their assessments on paper. Three submission methods are available for processing completed answer sheets.

  • Mobile App: Students or teachers scan sheets using the PaperScorer mobile app
  • Email Scanning: Scan sheets and email them directly to PaperScorer
  • Platform Upload: Upload scanned PDFs through your platform using the API

Relevant Endpoints

Submit Answer Sheet Processing Job/rest/ps/submitAnswerSheetProcessingJob
Get Processed Form IDs/rest/ps/getProcessedFormIDs
Scanning & Processing flow diagram
4

Score Retrieval

Once processing is complete, scores can be retrieved using either a push (callback-based) or pull (request-based) approach.

  • The getScoresByFormID endpoint returns detailed scoring results for each student.
  • Use acknowledgeSyncScore to remove processed results from future responses.

Relevant Endpoints

Get Scores By Form ID/rest/ps/getScoresByFormID
Acknowledge Sync Score/rest/ps/acknowledgeSyncScore
Score Retrieval flow diagram
5

Error Resolution

Failed scans or ambiguous responses can be addressed through the PaperScorer error resolution interface.

  • An iFrame tool allows educators to manually review and override scores.
  • The iFrame will load any exceptions related to an educator's scans for easy resolution.

Relevant Endpoints

Get Exception iFrame URL/rest/ps/getExceptionIframeUrl
Error Resolution flow diagram

Security & Encryption

All responses from the PaperScorer engine are encrypted with a key that is shared with our development partners for decryption. This ensures that sensitive student data remains protected during transmission.

Decryption Libraries

Sample decryption libraries available in PHP and Java

Secure Authentication

OAuth 2.0 authentication for all API requests

PHP DecrypterJava Decrypter
// Example: Decrypting API Response (PHP)
$encryptedData = $response['data'];
$key = getenv('PAPERSCORER_API_KEY');

$decrypted = openssl_decrypt(
  $encryptedData,
  'AES-256-CBC',
  $key,
  0,
  $iv
);

$scores = json_decode($decrypted, true);

Get Started for Free

You can create a free account with no obligation to purchase. Scan up to 100 testing sheets completely free while you test your integration.

Create Free AccountContact Integration Team