Testing in the Sandbox
Using Evernote's development server
Overview
When you get a new API key from us, it will only work in our sandbox. The sandbox is a separate instance of the Evernote service, designed as a safe environment for you to develop your applications without worrying about messing up your actual Evernote account or impacting our production service.
Sandbox User Accounts
Because it's a separate instance of our service, your real Evernote account won't work on the sandbox. To get started testing, create a new sandbox user account at https://sandbox.evernote.com. Feel free to create as many accounts as you need for testing on the sandbox. The sandbox isn't connected to a real commerce service, so if you need one or more of your sandbox account upgraded to Premium, please open a support inquiry and we'll upgrade them for you. Be sure to include the username(s) of the accounts that you want upgraded in your support request.
Sandbox Endpoint URLs
To use the sandbox in your application, simply change the hostname in the Cloud API endpoint URLs:
- Sandbox: https://sandbox.evernote.com/
- Production (International): https://www.evernote.com/
- Production (China): https://app.yinxiang.com/
For example, to access the NoteStore on the shard <shardId>, you will use the following URLs:
Sandbox: https://sandbox.evernote.com/edam/note/<shardId>
Production (International): https://www.evernote.com/edam/note/<shardId>
Production (China): https://app.yinxiang.com/edam/note/<shardId>
Getting out of the Sandbox
Once you have completed your development and testing on the sandbox, submit a key activation request and we'll activate your API key on the production Evernote service.
Accessing the Sandbox from Evernote Apps
During testing, you may want to access your sandbox account from one our apps. How you do this varies depending on the app that you're using. Before you follow any of the instructions below, synchronize your production account to ensure that all of your local notes have been sent to our service.
Evernote for Windows
- Quit Evernote from the File menu. If prompted, confirm that you'd like to fully exit Evernote.
- Run regedit
- Open the key HKEY_CURRENT_USER\Software\Evernote
- Edit the string value SyncServiceUrl, changing www.evernote.com to sandbox.evernote.com.
- Quit regedit
- Open Evernote and log in to your sandbox account
Android
- Close the Evernote app
-
Copy the bootstrap file to the /sdcard/Android/data/com.evernote/files/ directory
- Note: devices w/o an SDCARD drive will be /Android/data/com.evernote/files/
- Restart the Evernote app
iOS and other mobile applications
Log out of Evernote. At the log in screen, enter your sandbox username and password, then append "#sandbox.evernote.com" to the username and log in. For example, to log into the sandbox account "foo" with the password "bar", you would enter the following:
Username: foo#sandbox.evernote.com
Password: bar
Evernote for Mac
To use a sandbox account with the Evernote for Mac client:
- Quit the Evernote application
- Open up a terminal window and type: defaults write com.evernote.Evernote ENSubstituteServerName sandbox.evernote.com
- Open Evernote and login using your sandbox credentials
To revert back to the production version of Evernote after configuring the Evernote for Mac client to work with the sandbox as outlined above:
- Quit the Evernote application
- Open up a terminal window and type:
defaults delete com.evernote.Evernote ENSubstituteServerName - Open Evernote and login using your production credentials