Create an Application
As of right now, there is no way to self register an application. You'll need to contact me to get started by sending an email to email@example.com.
Once your application is created, you'll be given a public client ID. This ID will be locked to the domain(s) you specify when you request the application. The server will only redirect to approved domains with any authorization codes or tokens. You'll also need to specify scope for your application, which must be approved and are also locked to specified domains.
These are scopes that are publicly available upon request for your application:
- user: Read profile data for a given user.
- plan-nu: Read Paper plan and schedule data for a given user (read-only).
- plan-nu:write: Write Paper plan and schedule data for a given user (write-only, used alongside base level plan-nu scope to have read and write access).
Once you have a registered client, you can begin using the OAuth 2.0 flow to get an access token for a user, which can then be used to perform a restricted set of actions as the user with their approval. These tokens are commonly short-lived but can be refreshed with reauthentication.