Finding your API key
Before beginning, ensure that an account has been set-up for your correctly on our staging environment at https://staging.pencilapp.com/. You can check this by logging in and verifying you see a Profiles button on the left sidebar. If you do not see this, please contact Pencil Spaces Support and we'll be happy to assist.
Login to any account that is listed as an InstitutionAdmin for your institution. You can check your role on Profiles
Find the account that you're currently logged-into and open up your profile
Scroll down to "API Key" and follow the instructions provided to retrieve your API key
Preparing your application for production
Ensure that you have correctly set-up an account in production (at https://my.pencilapp.com)
Retrieve a production API key using the steps above. Once done, please update your code to point to our production endpoint: https://prod-api.pencilapp.com
You're all set!
Important notes
Our API documentation can be found here.
If issues occur in production, we update our Status Page. We recommend you subscribe to email notifications on the top right of the page.
By default our Swagger documentation uses our staging server. Contact Pencil Spaces Support to set-up your staging account with API access.
Our staging server is not a reliable production environment and can be unstable. If you encounter any issues, please contact Pencil Spaces Support, and explicitly mention you're using our staging environment for API development