Endpoints Creation

Endpoint Creation Strategy

Customer X must decide when endpoints should be created.

Two options exist:

• Create endpoints on demand when a traveler purchases a SIM

• Create endpoints in advance and activate them later SUGGESTED

Because endpoint creation is a resource-intensive operation on the SFT platform, the recommended approach is to:

• Create endpoints in advance

• Keep them in a Pre-Active state

• Activate them only when a traveler purchases connectivity via the portal

This approach improves scalability and reduces latency during customer onboarding.

APIs Used

The following APIs are typically used for this configuration:

• Create Endpoint API

• Create Bulk Endpoint API

Using bulk creation allows Customer X to:

• Efficiently provision large volumes of endpoints

• Prepare inventory ahead of demand

Integration Notes – Endpoint Creation

This section highlights the most important input and output parameters relevant to this use case.
It does not replace the full API reference.

For the complete list of parameters, validation rules, and examples, refer to the API Reference pages.

Key Input Parameters

The following input parameters are critical when creating endpoints in this scenario:

• name
  A human-readable name for the endpoint.
  Typically used for identification and inventory management.

• iccid
  The ICCID of the SIM to be attached to the endpoint.
  This determines which physical SIM is linked to the endpoint.

• isDefaultActivation
  Must be set to false.
  Endpoints should be created in a Pre-Active state and activated later, once a traveler purchases connectivity.

ℹ️ For all other optional and advanced parameters, refer to the API reference documentation.

Key Output Parameters to Store

The following output parameters must be stored by Customer X in its backend systems:

• endpointId
  The unique identifier of the endpoint.
  This ID is required for all subsequent operations, including:

  • Endpoint activation

  • Addon assignment

  • Usage retrieval

  • Lifecycle management

Customer X should store this value and maintain a mapping between the Endpoint name, endpointId and iccid for correct endpoint tracking and future API interactions.

Endpoint Tagging

To simplify endpoint management, Customer X may assign tags during endpoint creation.

For example:

• Tag a batch of endpoints as batch-1

• Use tags later to:

  • Identify unused endpoints

  • Perform bulk activation

  • Track inventory lifecycle

Tags provide a lightweight mechanism to organise and manage endpoints at scale.