First Package

When a user of your website or app is eligible to receive a mobile data package (e.g., the user made a purchase of an inventory item, and you received the money), you can issue the first data package.

The activation will use your credit balance on Gigastore. You can check for the history of activations here: https://dent.giga.store/#/your-store/history.

To activate, you need the following:

• inventoryItemId - see Offering Packages

• metatag, e.g. an internal transaction id (will be stored and can be retrieved via API)

• customerEmail - the email address of your customer (optional)

• userIp - current IP of the user

• userCountry - country of residence (use ISO2 code)

• expectedPrice - the retail price of the package (optional)

• activationMode - type of package activations (optional) see Activation Modes

To protect your payment flow, you can add the expectedPrice field. In this case, our API will check the price against the retail price of the inventory item. Only if the price matches will the API allow activation.

In order to ensure compliance with regional regulations, make sure to include user's IP and Country of Residence during the registration.

POST /gigastore/activations/register

Request:
{
    "inventoryItemId": "00e3e46e-faa5-465a-9321-1234567890",
    "metatag": "Comment for reseller...",
    "customerEmail": "[email protected]",
    "userIp": "123.45.67.89",
    "userCountry": "GR",
    "expectedPrice":{
            "sortIndex": 0,
            "priceValue": 9.99,
            "currencyCode": "USD"
    },
  "activationMode": "NOW"
}

Response:
{
  "status": "success",
  "activatedItem": {
    "balance": {
      "activatedAt": "2024-04-30T09:55:36.430Z",
      "expiresAt": "2024-04-30T09:55:36.430Z",
      "activationMode": "NOW",
      "name": "string",
      "size": {
        "sizeValue": 0,
        "sizeUnit": "TB"
      },
      "availableBalance": {
        "sizeValue": 0,
        "sizeUnit": "TB"
      },
      "validitySize": 365,
      "validityUnit": "years"
    },
    "uid": "string",
    "metatag": "Paid in cash",
    "salesChannel": "Application Programming Interface",
    "salesChannelTypeCode": "API",
    "activationType": "DATA_PLAN",
    "purchasePrice": {
      "sortIndex": 1,
      "priceValue": 4.99,
      "currencyCode": "USD"
    },
    "retailPrice": {
      "sortIndex": 1,
      "priceValue": 4.99,
      "currencyCode": "USD"
    }
  },
  "customer": {
    "email": "[email protected]",
    "uid": "123234345-234-cbd2-9321-1234567890",
    "profileUrl": "string"
  },
  "esimProfile": {
    "iccid": "string",
    "uid": "string",
    "imsi": "string",
    "activationCode": "string",
    "appleUniversalLink": "string",
    "installationUrl": "string",
    "lastSeen": "2024-04-30T09:55:36.430Z",
    "activatedAt": "2024-04-30T09:55:36.430Z",
    "state": "RELEASED"
  }
}

During the activation, different entries are created in the background and returned from the API:

• a customer linked to your account

• an activated item, linked to your customer

• an eSIM profile, linked to your customer

To use the package, the customer needs to install the eSIM profile. Please check the eSIM Profiles section for details.

Multiple Packages and eSIMs

Customers can have multiple activated items and multiple eSIM profiles. Please refer to the Customers section of the documentation.