Developer

Appearance

Authentication ​

Account ​

To use the rooomProducts API, you need to have a rooom account. If you don't have an account yet, you can create by visiting the rooom pricing and signup.

API-Keys ​

An API key are required to authenticate and use the rooomProducts API.
The Authorization header with a bearer token.

Authorization: Bearer <API_KEY>

INFO

The Bearer prefix in the header value is mandatory to interact with the rooomProducts API programmatically. You can learn more about it at IETF RFC 6750

Create an API-Key ​

API keys can be created and managed from inside your account settings.

Screenshot

  1. In the upper-right corner of your dashboard, click your profile picture, then select Settings
  2. Select Integrations from the sidebar
  3. Click on New API Key
  4. Enter a descriptive name for the api-key
  1. From the drop-down, select an expiration date for the key
  2. Click Create API Key
  3. Once you've created an API-Key, securely store the value as it will not be shown again.

Expiration ​

Setting an expiration date on an API-Key is highly recommended and is considered one of the standard security practices that helps keep your information secure. You can select from a default list of expiration dates ranging from 1 day to 3 months. You can view the expiration date of your API-Key on the key management list.

Failed Authentication ​

If authentication is unsuccessful for a request, the error status code 401 is returned.

API Key Safety ​

Once minted, API keys are not visible in the dashboard anymore, so please download and keep it safe and securely since anyone who obtains it can use it to talk to rooomProducts API on your behalf. If you believe your API key has been compromised, you can revoke it at any time from the dashboard, once revoked, it will no longer be valid.