API keys

The Integration, API keys area manages the credentials used to connect your company's system to Raims. Sandbox and Production keys belong to separate environments and must not be reused between them.

Viewing keys requires API keys. Creating, rotating, renaming, revoking, and managing IPs have their own permissions. These actions may also be blocked when the account is in view-only mode. Use these credentials to authenticate requests to the Raims API.

Viewing logs also requires View request logs. This access allows you to read the details and request and response bodies available in the history. Access to keys does not automatically grant access to logs. See how to grant this permission to your team.

Keep the key secret

Never put a Raims key in a browser, distributed apps, repositories, screenshots, or logs. Keep the credential in the private part of the system responsible for the integration.

Create a key

Open API keys

Go to Integration, API keys, Create new API key with Create API keys. Check the selected environment before creating the key. Accounts without access to Production can create Sandbox keys only.

Give it an operational name

Enter the Key name and check the Key type. Use a name that identifies the system and environment, such as ERP - Sandbox or Main integration - Production.

Restrict the source when possible

If the system uses fixed outbound addresses, allow only those IPv4 addresses or CIDR ranges.

Copy and store it immediately

Select Create. The secret is shown only once when creating or rotating the key. Save it in a secrets vault before closing the dialog.

Separate environments

Test keys use placeholders such as sk_test_... and are for development and integration testing. They do not process real money.

The API reference presents authentication, fields, and examples for each request. The console accepts Sandbox keys for testing the integration.

Secure storage

Use a secrets manager or a protected variable in the environment where the integration runs. Example files must contain only the variable name:

.env.example

RAIMS_API_KEY=sk_test_...

Do not commit a real .env file. Limit access to the people and systems that need to use the integration.

IP restrictions

The Dashboard accepts an individual IPv4 address, such as 203.0.113.10, or a CIDR range, such as 203.0.113.0/24. Use only stable outbound addresses confirmed by your infrastructure.

Enter the four decimal IPv4 numbers separated by periods, without leading zeros. Each number must be between 0 and 255. For a CIDR range, add / and an integer prefix from 0 to 32, with no sign or leading zeros.

The range includes the entire network indicated by the prefix. For example, 203.0.113.7/24 appears as 203.0.113.0/24 and covers 203.0.113.0 through 203.0.113.255. The /32 prefix appears as an individual IP. Entries that represent the same range appear only once. Check the list before saving, especially when entering a shorter prefix, which allows a larger range of addresses.

Prop

Type

Rename a key

Go to Integration, API keys and open the actions for the key.
Select Rename key, enter the new name, and confirm Rename key.
Wait for confirmation and check the name in the list.

This action requires Edit API keys. It changes only the displayed name; existing integrations continue using the same secret.

Rotate a key

Go to Integration, API keys and open the actions for the correct key.
Select Rotate key token, check the notice, and confirm Rotate token.
Copy and store the new secret before closing the dialog.
Update the systems that used the previous token.

This action requires Rotate API keys. Rotation replaces the previous secret; the key keeps the settings shown.

Manage IP restrictions

Go to Integration, API keys and open the key's actions.
Select Manage IP restrictions.
Add, edit, or remove only the IPv4 addresses and CIDR ranges used by your system. Check the confirmation for each change.
Use Download list if you need to save the configured addresses.

Changes require Manage API IPs. Read IP restrictions in this guide before defining a network range. An empty list leaves the key without source restrictions.

Revoke a key

Go to Integration, API keys and open the actions for the key you want to disable.
Select Revoke API key, check the identified token, and confirm Revoke key.
Wait for Key revoked.

This action requires Delete API keys and revokes the key. Systems that still depend on that token must be updated with another valid credential.