Guide

API Generation

The API page allows administrators to generate API credentials for a specific customer, device, and SIM card. These credentials enable external applications to securely connect with TextGem and send SMS messages through the selected device.

Overview

The API generation page simplifies the process of creating API access for connected devices. Before generating an API, you must select the customer, device, and SIM card that will be associated with the API credentials.

Select a Customer

The Customer field is used to select the customer for whom the API will be generated.

To Select a Customer

Click the Customer dropdown.
Search or select the required customer.
Ensure a customer is selected before proceeding.

Validation

If no customer is selected, the system displays a validation message indicating that the customer is required.

Select a Device

The Device dropdown lists all available devices associated with the selected customer.

To Select a Device

Click the Device dropdown.
Choose an active connected device.
Verify that the device is online and available.

Benefits

Associate the API with the correct device.
Ensure SMS requests are routed through the selected device.

Select a SIM Card

The SIM dropdown displays the SIM cards available on the selected device.

To Select a SIM

Click the SIM dropdown.
Choose the SIM card to be used for SMS communication.
Confirm the selected SIM is active.

Selecting the appropriate SIM ensures that messages are sent using the intended mobile network.

Generate API Credentials

Once all required fields have been completed, you can generate the API credentials.

To Generate an API

Select a customer.
Select the required device.
Choose the appropriate SIM card.
Click Generate.

The system creates API credentials that can be used to integrate external applications with TextGem.

Cancel the Process

If you do not wish to continue, click Cancel to exit the page without generating an API.

Validation

The system validates all required fields before generating the API.

Common Validation Rules

Customer selection is mandatory.
A valid device must be selected.
A SIM card must be selected before API generation.

If any required field is missing, the system displays an appropriate validation message.

Best Practices

Generate API credentials only for authorized customers.
Verify the selected device and SIM before generating the API.
Keep generated API credentials secure and confidential.
Regenerate API credentials if they are suspected to be compromised.
Test the generated API before integrating it into production applications.