API and webhooks
Create an API key, and what the public API lets you do on a paper exam: copies, scan import, enrollments and grades.
Written By Florian Barral
Last updated 9 days ago
The public API lets your tools (information system, scripts, intranet) read your paper exams, download the copies, send the scans and retrieve the grades. It is reserved for organization administrators.
Create an API key
Click your name at the bottom of the sidebar, then Settings.
In the Administration section, open API.
In API keys, click New key.
Give it a Key name that helps you recognize it, then click Create key.
Copy the Client ID and the Client secret, then click I saved my credentials.
The client secret is only shown once. Store it in a secret manager. If you lose it, delete the key and create a new one.
A key gives access to all of the organization's data. To cut off access, click Delete: the integrations using it stop working immediately.
Authenticate
Your tool exchanges the client ID and the client secret for an access token (OAuth 2.0, client_credentials), then sends it with every call. The Read more link on the API keys card opens the full API documentation: addresses, parameters and examples.
What the API lets you do on a paper exam
Create the exam, set up the copies and start their generation in Papeez: the API reads this state and serves the files, but does not create paper exams. Pages the analysis could not match to a participant are handled in Papeez: see Import the scans.
Webhooks
On the same page, the Webhooks card sends your organization's events to your servers as they happen: New webhook, then the Destination URL (https) and the Events to receive. For a paper exam, the useful events concern the emails sent to participants (sent, delivered, opened…). There is no event yet for scans or grades: query the API to follow the scan analysis.
API keys are available with all plans. Webhooks are not included in every plan: if that is the case for yours, Papeez tells you when you create one.
Frequently asked questions
I cannot see the API page
I cannot see the API page
The Administration section of the settings is reserved for organization administrators.
A scan import is refused on an anonymous exam
A scan import is refused on an anonymous exam
On an exam with anonymous copies, enroll the participants first: Papeez needs the list of enrolled participants to match each copy. See Nominative or anonymous copies.
Downloading the copies returns an error
Downloading the copies returns an error
The files only exist once the copies have been generated in Papeez. See Generate the copies to print.
Was this helpful?
More in Integrations
SSO integrationStill need help? Ask the team