Skip to main content

Set up your Alef Edge Private Mobile Network

Once you have completed the tasks in the above section, you're ready to set up your first Alef Edge Private Mobile Network. The steps are as follows:

  1. Check your account details
  2. Create site address
  3. Order a mobile network
  4. Configure your mobile APs
  5. Enable your eSIM download
  6. Install eSIM onto your mobile device (UE)

1. Check your account details​

To check your account details you must provide your <ACCOUNT_ID> and <API_KEY>

You will be using the /connectivity/v1/account endpoint with the GET method.

Examples:

curl

curl --location --request GET 'https://api.alefedge.com/connectivity/v1/account?account_id=<ACCOUNT_ID>&Authorization=<API_KEY>' \
--header 'Accept: application/json'

Python

import requests

url = "https://api.alefedge.com/connectivity/v1/account?account_id=<ACCOUNT_ID>&Authorization=<API_KEY>"

payload={}
headers = {
'Accept': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Sample response

[
    {
        "account_id": "62cd07fb8918c140d8355555",
        "account_name": "ACloudenterprise Inc.",
        "account_address": [
            {
                "line1": "7 address Tower",
                "line2": "100 address St",
                "city": "Hebron",
                "state": "KY",
                "country": "US",
                "postal_code": 41048,
                "_id": "62cd07fb8918c140d8355555"
            }
        ],
        "billing_address": [
            {
                "line1": "7 address Tower",
                "line2": "100 address St",
                "city": "Hebron",
                "state": "KY",
                "country": "US",
                "postal_code": 41048,
                "_id": "62cd07fb8918c140d8355555"
            }
        ],
        "contract_id": "d40c867624ede53ef9012345",
        "billing_entity": "ACloudenterprise Inc.",
        "billing_contact": [
            {
                "email": "john@doe.com",
                "name": "John Doe",
                "contact_number": "+918007012345",
                "_id": "62cd07fb8918c140d8312345"
            }
        ]
    }
]

2. Create a site address​

In order to connect to an Alef Edge Point, you must first create a site address where you intend on ordering services to.

To create your site you must provide your <API_KEY> and your site details.

You will be using the /connectivity/v1/account/customersiteaddress endpoint with the POST method.

Examples:

curl

curl --location --request POST 'https://api.alefedge.com/connectivity/v1/account/customersiteaddress?Authorization=<API_KEY>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"customer_site_name": "NYC east office site",
"customer_site_address": {
    "line1": "7 address Tower",
    "line2": "100 address St",
    "city": "Hebron",
    "state": "KY",
    "postal_code": 41048,
    "country": "US"
},
"contact_details": {
    "name": "Alex Hales",
    "phone_number": "+12223334444",
    "email": "your@email.com"
},
"is_default_shipping_address": true
}'

Python

import requests
import json

url = "https://api.alefedge.com/connectivity/v1/account/customersiteaddress?Authorization=<API_KEY>"

payload = json.dumps({
"customer_site_name": "NYC east office site",
"customer_site_address": {
    "line1": "7 address Tower",
    "line2": "100 address St",
    "city": "Hebron",
    "state": "KY",
    "postal_code": 41048,
    "country": "US"
},
"contact_details": {
    "name": "Alex Hales",
    "phone_number": "+12223334444",
    "email": "your@email.com"
},
"is_default_shipping_address": True
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Sample response

{
    "customer_site_address_id": "62cd0a274e6842854ad12345",
    "createdAt": "2022-07-12T05:44:07.992Z"
}

3. Order a Mobile network​

To create your order you must provide your <API_KEY>, <SITE_ID> and order details. Most of the order fields are self explanatory, however please take note regarding the following:

  • create_dedicated_apn True/false. refer to Do I need a dedicated APN? for more details.
  • pdn_name An optional value that we would use to generate your dedicated APN name if you order one.
  • bandwidth The bandwidth you will require between the Alef Edge Point and your network
  • preferred_carrier The preferred carrier for connectivity between your network and the Alef Edge Point
  • ue_ip_pool If you are ordering a dedicated APN you can define the IP address pool that will be used by your mobile devices (UEs)
  • ip_subnets_for_enb The range of ip addresses that can be allocated to APs on the network. This is required when access_point_quantity is set, but should be left blank otherwise.
  • epc_provider The mobile core you will use for attaching to the mobile network and signalling. Options are SYNIVERSE or RFCONNECT. Default is SYNIVERSE.

You will be using the /connectivity/v1/order endpoint with the POST method.

Examples:

curl

curl --location --request POST 'https://api.alefedge.com/connectivity/v1/order?Authorization=<API_KEY>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"customer_site_id": "<SITE_ID>",
"order_type": "NORMAL_ORDER",
"use_as_shipping_address": false,
"shipping_address": {
    "line1": "address",
    "line2": "address",
    "city": "Beverly Hills",
    "state": "CA",
    "country": "US",
    "postal_code": "90210"
},
"epc_provider": "SYNIVERSE"
"pdn_name": "Verizonpdnname",
"create_dedicated_apn": true,
"apn_name": "mmapn_name",
"shipping_contact_detail": {
    "name": "John Doe",
    "contact_number": "+12222384444"
},
"bandwidth": "200Mbps",
"preferred_carrier": "AT&T MPLS",
"access_point_quantity": 2,
"ue_ip_pool": [
    "192.168.1.30/24",
    "192.148.3.10/16"
],
"ip_subnets_for_enb": "192.168.1.30/24",
"esim_quantity": 1,
"sim_quantity": 1
}'

Python

import requests
import json

url = "https://api.alefedge.com/connectivity/v1/order?Authorization=<API_KEY>"

payload = json.dumps({
"customer_site_id": "<SITE_ID>",
"order_type": "NORMAL_ORDER",
"use_as_shipping_address": False,
"shipping_address": {
    "line1": "your address",
    "line2": "your address",
    "city": "Beverly Hills",
    "state": "CA",
    "country": "US",
    "postal_code": "90210"
},
"epc_provider": "SYNIVERSE"
"pdn_name": "Verizonpdnname",
"create_dedicated_apn": True,
"apn_name": "Verizonapn_name",
"shipping_contact_detail": {
    "name": "John Doe",
    "contact_number": "+1897712345"
},
"bandwidth": "200Mbps",
"preferred_carrier": "AT&T MPLS",
"access_point_quantity": 2,
"ue_ip_pool": [
    "192.168.1.30/24",
    "192.148.3.10/16"
],
"ip_subnets_for_enb": "192.168.1.30/24",
"esim_quantity": 1,
"sim_quantity": 1
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Sample response:

{
    "order_id": "62cd181a4321be80df612345",
    "status": "RECEIVED",
    "message": "Order Created",
    "updated_at": "2022-07-12T06:43:38.633Z"
}
tip

To view your order, use the GET method with the /connectivity/v1/order endpoint.

Order confirmation and Service provisioning information​

You will receive 2 emails around 10 minutes after you place your order:

Order Details
This email will contain links to Zip files to download your eSIMs and the inventory details of any physical SIMs you have ordered. The password for these Zip files will be the first 4 digits of your Order ID,and the first 4 digits of your Account ID.

Service Provisioning
This email contains the details of your order, as well as mobile AP (eNodeB) configuration information. You will must use this information to configure your mobile APs connectivity to the EPC:

  • TAC (Tracking Area Code) Used with the PLMN to make up a globally unique tracking identity for the A**
  • PLMN (Public Land Mobile Network) Used with the TAC to make up a globally unique tracking identity for the A**
  • MME IP An IP address that your AP will use to connect to the EPC**
  • SGW This is not to be confused with the SecGW address (see below). You will not need to configure this on your AP, as the MME will inform the AP of this address, however, the AP will then be communicating with the SGW so you need to ensure this is permitted on your firewalls.

If you are using IPSec to connect to the Alef Edge Point (see Edge Point - mobile AP Connectivity Options, we will also contact you directly with the Security Gateway (SecGW) address to configure on your AP. This will be the address of the nearest Alef Edgepoint to the location of the APs.

If you have ordered a private APN, the order will take 15 days. When the order is complete you will receive an email.

Breakout configuration​

When we receive your order we will begin working with your chosen carrier (who you specified in the preferred_carrier field) to provision network connectivity between the Edge Point and your enterprise site, and route your mobile user traffic back to your network.

4. Configure your mobile AP connectivity​

Refer to the AP configuration information you received from us, and configure your AP with:

  • TAC
  • PLMN
  • MME IP
  • SecGW IP (If you are using IPsec to connect to the Alef Edge Point.)
note

We will also send you the SGW IP. You do not need to configure this on your AP, but your AP will communicate with the SGW so you will need to ensure this IP is permitted on your firewalls.

5. Enable your eSIM download​

Once eSIM download is enabled, a user can use either the QR code or Activation Code to download the eSIM profile to the mobile phone and initiate eSIM installation. In order to enable eSIM download you will need the eSIM's MSISDN, IMSI or ICCID. You can find these on your Zip file, or you can get information for a SIM via the API:

Get your eSIM/SIM info​

You will be using the /connectivity/v1/sim endpoint with the GET method.

To get your SIM info, you must provide your <API_KEY>, and either your <ORDER_ID> , or one of the following that you will see in your zip files: <MSISDN> or <IMSI> or <ICCID>

Examples:

curl

curl --location --request GET 'https://api.alefedge.com/connectivity/v1/sim?order_id=<ORDER_ID>&epc_provider=<EPC_PROVIDER>&msisdn=<MSISDN>&imsi=<IMSI>&iccid=<ICCID>&apikey=<API_KEY' \
--header 'Accept: application/json'

Python

import requests

url = "https://api.alefedge.com/connectivity/v1/sim?order_id=<ORDER_ID>&epc_provider=<EPC_PROVIDER>&msisdn=<MSISDN>&imsi=<IMSI>&iccid=<ICCID>&apikey=<API_KEY>"

payload={}
headers = {
'Accept': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Sample response

[
    {
        "iccid": "89802001000000012345",
        "imsi": "310550000012345",
        "msisdn": "802001012345",
        "status": "ACTIVATED",
        "state": "AVAILABLE",
        "epc_provider": "SYNIVERSE",
        "sim_type": "ESIM",
        "account_id": "62cd28ecc7cfe89ae6a12345",
        "apn_name": "your.apn",
        "order_id": "62cd2c4b276d434da5b12345",
        "qr_code_path": "https://dvmaan266gbjc.cloudfront.net/QR-code/62cd28ecc7cfe89ae6ae010d_1657613412345.zip"
    }
]

Enable eSIM download​

You will be using the /connectivity/v1/sim/enable endpoint with the PUT method.

To enable your eSIM download, you must provide your <API_KEY>, and either the <IMSI, <ICCID> or <MSISDN> of the eSIM.

Examples:

curl

curl --location --request PUT 'https://api.alefedge.com/connectivity/v1/sim/enable?iccid=<ICCID>&imsi=<IMSI>&msisdn=<MSISDN>&apikey=<API_KEY>' \
2--header 'Accept: application/json'

Python

import requests

url = "https://api.alefedge.com/connectivity/v1/sim/enable?iccid=<ICCID>&imsi=<IMSI>&msisdn=<MSISDN>&apikey=<API_KEY>"

payload={}
headers = {
'Accept': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

Sample Response

"message": "eSIM state set to RELEASED. eSIM download enabled successfully."

6. Install eSIM onto your mobile device (UE)​

As mentioned previously, you can download the zip file containing a QR code for your eSIM from the link provided in your order confirmation email, or that you have requested via the /connectivity/v1/sim endpoint. The password to the zip file is the first 4 digits of the Order ID and first 4 Digits of your account ID.

Once you have opened the zip file, you will need to scan the QR code into the phone.

Activate eSIM on IOS​

  1. Follow the steps given below to download and activate an eSIM on an iPhone.
  2. Go to Settings > Cellular.
  3. Tap Add Cellular Plan to add a new SIM profile.
  4. Scan the eSIM QR code to download the eSIM profile.
  5. Tap on the plan and set the value for APN (access point name for the eSIM) to the name you have been given, or if you have ordered one, to your dedicated APN name.

Activate eSIM on Android​

Note: Google Pixel is used to describe the steps below. The steps would vary based on the Android device model.

  1. Follow the steps given below to download and activate an eSIM on an Android.
  2. Go to Settings > Network & Internet, and click Mobile Network.
  3. Select Download a SIM instead?
  4. Click Next.
  5. Click OK to allow the SIM download.
  6. Select the Use a Different Network option.
  7. Scan the eSIM QR code to download the eSIM profile.
  8. Click Activate to enable the eSIM once the eSIM profile is detected.

Your eSIM should be activated in 15 to 20 minutes. Once the cellular plan is activated, your mobile device is ready to connect to the private edge network. Once the breakout connectivity has been provisioned, your mobile user traffic will be routed from the Alef Edge Point back to your network.