Testing

We provide fake network providers for you to use when testing your integration. These providers support the use of placeholder SIM information or test phone numbers to influence the behavior of the API.

Test Providers

The following test providers are currently available:

Test SIMs

Test SIMs can be used for testing purposes or to get you going with the Gigs API while you are waiting on real SIMs to be made available to you. These SIMs use a test provider and behave like any other API SIM resource, but don't provide actual connectivity.

How to Use Test SIMs

The following Gigs API endpoints support the use of test SIMs:

• Create a subscription
• Create a device
• Update a device
• Search for SIMs

A new test SIM instance will automatically be created when you use a special placeholder SIM in a POST request such as: sim_test_psim. This new test SIM instance will be generated with a unique resource ID as well a unique ICCID, starting with 8942424242 followed by 9 characters, for example: "iccid": "89424242428486763002".

Example: Creating a Subscription

To use a test SIM in a subscription, you create a subscription with a special placeholder SIM ID in the request. A new test SIM instance will be automatically created and associated to the newly created user's subscription. For example, the request to create a new subscription with a test pSIM (using placeholder SIM ID: sim_test_psim) is:

$ curl --request POST \
--url "https://api.gigs.com/projects/${GIGS_PROJECT}/subscriptions" \
--header "Accept: application/json" \
--header "Authorization: Bearer ${GIGS_TOKEN}" \
--header "Content-Type: application/json" \
--data '{
  "plan": "...",
  "sim": "sim_test_psim"
  "user": "...",
}'

This will result in a response similar to:

{
  "object": "subscription",
  "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
  "currentPeriod": {...},
  "phoneNumber": "+25411865216434",
  "plan": {...},
  "sim": {
    "object": "sim",
    "id": "sim_0SNlurA049MEWV3clHBExvxoU22R",
    "type": "pSIM",
    "iccid": "89424242428486763002",
    "provider": "test",
    "status": "inactive",
    "createdAt": "2021-01-21T19:38:34Z"
  },
  "status": "pending",
  "user": {...},
  ...
}

The response contains the unique id and ìccid of the new SIM resource.

Example: Searching for a test SIM

To find the placeholder SIMs, you can search for them using the SIM search endpoint with the fixed ICCIDs, for example looking up the placeholder eSIM - 8942400090000000010:

$ curl --request "POST" \
--url "https://api.gigs.com/projects/${GIGS_PROJECT}/sims/search" \
--header "Accept: application/json" \
--header "Authorization: Bearer ${GIGS_TOKEN}" \
--header "Content-Type: application/json" \
--data '{"iccid": "8942400090000000010"}'

The response provides the details of the placeholder eSIM with the placeholder SIM ID:

{
  "object": "list",
  "items": [
    {
      "object": "sim",
      "id": "sim_test_esim",
      "iccid": "8942400090000000010",
      "provider": "test",
      "status": "inactive",
      "type": "eSIM",
      "createdAt": "2021-01-01T00:00:00Z"
    }
  ],
  "moreItemsAfter": null,
  "moreItemsBefore": null
}

Overview of Test SIMs

The Gigs API supports both embedded and physical SIMs with different activation delays for testing purposes. A test SIM ID with a delay such as sim_test_psim_delayed_up_to_one_min or sim_test_esim_delayed_four_hours will result in a created subscription which starts off in the status of "pending" before transitioning to a status of "active". The transition time depends on the defined delay for the corresponding SIM.

To make use of a test SIM, insert one of the below placeholder SIM IDs in a supported create request. The placeholder SIM IDs are organized by provider.

Test Phone Numbers

Test phone numbers are used to simulate different porting scenarios and verify that the integration with the porting API works correctly.

To make use of a test phone number, insert one of the below placeholder SIM IDs when creating a porting. The phone numbers are organized by provider.