Skip to main content

Setup Customer Site

info

You will be using the Alef Mobile Network API to carry out the tasks in this section. This is a basic config, Refer to the API reference documentation to learn more about the API and explore the full schema.

Create a site​

Required information

  • name: Site name, needs to be unique in your account.
  • address: Full address of the location. Second line is optional.
  • contact:
    • name: First and last name of the (local) contact person for the site.
    • email: email address of the contact person (used for operation communication only).
    • phone-number: phone number of the contact person (used for operation communication only).

You will create a site which is the physical location where your RAN (your mobile APs) reside. This information is needed when provsioing the RAN for your Mobile Network.

You will use the following POST request body with the /accounts/v2/account/site endpoint to create your site.

You can use the following GET request body with the /accounts/v2/account/site/:id endpoint to retrieve your site information.

Expand here to see the customer site POST request body. 
{
   "name": "Customer site 1",
   "address": {
        "line1": "100 Main St",
        "line2": "#123",
        "city": "Fairfax",
        "state": "VA",
        "country": "US",
        "zipcode": "12345"
   },
   "contact": {
        "name": "John Doe",
        "email": "john@doe.com",
        "phone-number": "+1 1234567891"
   }
}

Examples​

info

All APIs require users to be authenticated with their username/password. The JWT token needs to be added to the header as Bearer of each call.

Expand here to see example Customer Site POST and GET requests and responses.

Request

curl -X 'POST' 'https://api.alefedge.com/accounts/v2/account/site' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ 
    "name": "Customer site 1",
    "address": {
        "line1": "100 Main St",
        "line2": "#123",
        "city": "Fairfax",
        "state": "VA",
        "country": "US",
        "zipcode": "12345"
    },
    "contact": {
        "name": "John Doe",
        "email": "john@doe.com",
        "phone-number": "+1 1234567891"
    }
}'

Response

{
    "name": "Customer site 1",
    "account_id": "66992fb6310e8d77a42ed77a",
    "address": {
        "line1": "100 Main St",
        "line2": "#123",
        "city": "Fairfax",
        "state": "VA",
        "country": "US",
        "zipcode": "12345"
    },
    "contact": {
        "name": "John Doe",
        "email": "john@doe.com",
        "phone-number": "+1 1234567891"
    },
    "service-status": {
        "status": "active"
    },
    "_id": "66993642310e8d77a42ed780",
    "__v": 0
}
tip

Take a note of the returned object ID _id for your site, as you will need it in the following steps. It will be an alphanumeric string, something like 66993642310e8d77a42ed780.