The Settings page allows you to manage some of your organization's setup. Here, you can create API keys, configure webhooks for updates, and enable or restrict access using IP whitelisting.

API keys are auto-generated keys that allow your systems to connect to Bitnob Business securely and perform actions such as fetching data, initiating transactions, or listening for events.

Each API key is unique and should be kept private.

1. Go to Settings, click on API keys.
2. Click on the Generate New Key button.
3. Enter a preferred name or label for the key (e.g. Backend Service).
4. Click on Generate Key.
5. Copy the generated API key and store it in a secure place.

NB: You will only see the API key once. If you lose it, you'll need to generate a new one.

Labels help you identify where each API key is used, especially when you're managing multiple services or environments.

For security reasons, API keys cannot be recovered. If lost, you must revoke the key and generate a new one.

Webhooks allow Bitnob to notify your system in real time when important events happen. These events can be transaction updates, status changes, or system alerts.

1. Go to Settings and click on Webhooks.
2. Click on Create Webhook.
3. Enter a name or label for the webhook.
4. Enter your endpoint URL (where events will be sent).
5. Add a webhook secret; this is used to verify where webhook events are coming from.
6. Set your retry count using the dropdown or input the number. This defines how many times Bitnob will retry delivery if the webhook fails. The maximum retry count is 10.
7. Click on the Create Webhook button.

Once created, your webhook details will appear in the table with webhook name, endpoint URL, and date added. From this table, you can edit your webhook endpoint URL or delete a webhook. You can also add multiple webhooks for different services.

A webhook secret is a shared key used to verify your webhook signatures and ensure that the webhook events are authentic.

Bitnob will retry sending the webhook based on the retry count you initially set up. Once the maximum retry count is reached, delivery attempts stop.

IP whitelisting restricts API access so that only requests from trusted IP addresses can connect and communicate with Bitnob. This adds an extra layer of security for your organization.

1. Go to Settings and click on IP Whitelisting.
2. Click the Add IP Address (+) button.
3. Enter a name or label for the IP address.
4. Enter the IP address. We support both IPv4 and IPv6.
5. Click Whitelist IP.

Once done, the status of the IP address is updated to Active.

Each whitelisted IP appears in a table showing:

• Name or label
• IP address
• Status
• Date added

On this table, you can edit or delete your IP address; you can add multiple IP addresses and update an IP address from active to inactive state using a toggle.

Any API request coming from a non-whitelisted IP will be blocked by Bitnob, this ensures security.