Skip to main content

Part 2: Managing My Applications

The My Applications section allows you to oversee your sandbox applications, track their compliance, and manage API credentials.


Step 1 — Access Your Applications

On the left-hand navigation sidebar, click on My Applications.

Access My Applications


Step 2 — Register a New App

To create a new integration, click the blue + Register New Application button at the top right of the page.

Register New Application


Step 3 — Enter Application Name

Click the Application Name field and choose a descriptive name for your application.

Enter Application Name


Step 4 — Add Description

Fill out the Description field to explain what your application does and how it uses the APIs.

Add Description


Step 5 — Continue to Next Step

Click Continue to proceed to the platform selection step.

Continue


Step 6 — Select Platform

Choose the target platform for your application (e.g., Web, Mobile, Server-side).

Select Platform


Step 7 — Select Technology Stack

Choose the technology stack that best describes your application.

Select Technology Stack


Step 8 — Continue to API Selection

Click Continue to move on to the API subscription step.

Continue to API Selection


Step 9 — Search for APIs

Search the catalog for APIs by name or description to subscribe your application.

Search for APIs


Step 10 — Select API Version

Choose the specific version of each API you want to integrate with.

Select API Version


Step 11 — Continue to Configuration

Click Continue to proceed to the advanced configuration step.

Continue to Configuration


Step 12 — Enter Webhook URL

Optionally provide a webhook URL to receive real-time event notifications from the API.

Enter Webhook URL


Step 13 — Configure IP Whitelist

Add IP addresses to the whitelist for additional security on your API requests.

Configure IP Whitelist


Step 14 — Select Data Residency

Choose the data residency region to comply with data sovereignty requirements.

Select Data Residency


Step 15 — Review Configuration

Click Continue to move to the final review step.

Review Configuration


Step 16 — Review Application Details

Carefully review all the application details before submitting for registration.

Review Application Details


Step 17 — Register Application

Click Register Application to complete the registration process.

Register Application


Step 18 — Secure Your API Key ⚠️

A modal will display your Sandbox API Key one time only. Click Copy Key and store it securely in a password manager or secrets vault. You will never be able to view this key again after closing this modal.

Secure Your API Key

warning

This is the only time the API key is shown. If you lose it, you must rotate the key from the application settings.


Step 19 — Confirm Key is Stored

After copying and safely storing your key, click "Done, I have safely stored the key".

Confirm Key Stored


Step 20 — Manage Existing Applications

Each application card shows total API calls, creation date, and compliance progress, along with action buttons.

Manage Applications


Step 21 — Rotate API Key

Click the Rotate Key button to generate a new API key for your application. Use this if your key is compromised.

Rotate API Key


Step 22 — Confirm Key Rotation

Click Rotate Key in the confirmation dialog to proceed with generating a new API key.

Confirm Key Rotation


Step 23 — Copy the New Key

Click the Copy Key button and securely store the new key in a password manager or secure location.

Copy New Key


Step 24 — Confirm Storage

Click "Done, I have safely stored the key" to dismiss the modal and confirm you have stored the new key.

Confirm Storage


Step 25 — Edit Application

Click the Edit button to modify the name, description, or configuration of your application.

Edit Application


Step 26 — Save Your Changes

After making your edits, click Save Changes to apply the updates to your application.

Save Changes


Step 27 — Return to Dashboard

Click Return to Dashboard to go back to the main applications view.

Return to Dashboard


Step 28 — Delete Application

Click the red Delete button to permanently remove the application from your workspace.

Delete Application


Step 29 — Confirm Deletion

Type the exact application name in the confirmation field to confirm and permanently delete it from your workspace.

Confirm Deletion

danger

Deletion is permanent and cannot be undone. All sandbox credentials for this application will be immediately invalidated.