Creating an API key

To use the Rose API or the rosepy Python library, you'll first need to generate an API key for your account. These credentials can be created via the Settings → API Keys page in the SimpleRose web interface.

Follow these steps to create the required credentials.

1. Login to the SimpleRose web interface
2. Click on your name in the upper right and select 'API keys' from the dropdown menu
3. Click the 'Create new API Key' button
4. Enter a name for your API key and click 'Create'
5. Save the API key that is shown. You will not be able to view it after you leave the page.

For other tips and information on using API keys, see our API key best practices.