Creating an API key and secret

To use the Rose API or the rosepy Python library, you'll first need to generate an API key and secret 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 the gear icon in the lower left to navigate to the settings page
3. Click the 'API keys' tab
4. Click the 'Create new API Key' button
5. Enter a name for your API key and click 'Create'
6. Save the API key ID and secret that are shown. You will not be able to view the secret again after you leave the page.

Note: To use the API, you’ll also need your account ID, which is displayed at the top of the API Keys page. This ID uniquely identifies your organization within SimpleRose.

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