Skip to content

API keys

Last update · 3 min read

Give your system a key so it can call the RU4M API. Each key works for every company your integration access covers.

Before you start

You need approved integration access. Read Requesting integration access if you do not have it yet. Only a company's Owner or Admin can open these pages.

You can have up to 10 active keys. A retiring key still counts until it stops working. The new key page shows how many are in use, for example 3 of 10 keys in use.

If RU4M has suspended your access, you cannot create or rotate keys. New key and Rotate are disabled until RU4M restores access. You can still revoke a key.

Where to find it

  1. Select Integrations in the bar on the left.
  2. Select API keys in the Integrations panel.

You can also open API keys directly. The New key button is also on the Overview page.

The table lists each key with its Name, Environment, Key, Last used and Created date. The Key column shows only the start of each key, never the whole key.

Use Search keys… to find a key by name. Use the Environment filter to show only Live or Test keys. Switch on Show revoked to see revoked keys too.

Creating a key

  1. Select New key.
  2. Type a Name. Only your team sees this name.
  3. Under Environment, select Live for your production systems or Test for development and staging.
  4. Select Create key.
  5. Select Copy key.
  6. Paste the key into a safe place, such as your password manager.
  7. Tick I have saved this key somewhere safe.
  8. Select Done.

The page Your key is ready shows the key once. RU4M does not keep a readable copy, so you cannot see the key again.

The page also shows which companies the key works for, who created it and when. Select Make your first request to open the API reference.

Rotating a key

Rotate a key when you replace it with a new one, for example when you think someone else has seen it.

  1. Find the key in the table.
  2. Select Rotate.
  3. Choose how long the current key keeps working: Now, 1 hour, 24 hours or 7 days. 24 hours is selected by default.
  4. Select Rotate key.
  5. Select Copy key in the New key for “{name}” card.
  6. Tick I have saved this key somewhere safe.
  7. Select Done.

The old key shows Retiring · works until {date} until it stops working. The new key shows Previous key works until {date}. The Overview page lists the retiring key under Needs attention, so you remember to move your system to the new key.

If you choose Now, the old key stops working immediately.

Revoking a key

  1. Find the key in the table.
  2. Select Revoke.
  3. Select Revoke key in the dialog.

Systems that use the key stop working immediately. You cannot undo this. The key disappears from the table unless Show revoked is on.

Troubleshooting

You lost a key. RU4M cannot show it again. Rotate the key to get a new one.

New key is disabled. You already have 10 active keys, or RU4M has suspended your access. With 10 keys, the button hint reads 10 of 10 keys in use. Revoke a key you no longer use.

Rotate is disabled. RU4M has suspended your access, or a new key or secret is still waiting on this page. Select Done on that card first.

Rotating reports that you reached the limit. During rotation, the old key and the new key both count. The dialog switches to Now. Select Rotate key again to replace the old key immediately.

The app asks "Leave without saving the key?" You are leaving before you copied the key or ticked the checkbox. Select Stay and copy the key. Select Leave anyway only if you do not need the key.

Back to Integrations