tip

This section contains links to our API Specifications and is aimed at users who have already gone through our Quickstart Guide but want to dig deeper. If you are new to using the Alef APIs, please refer back to Set up your first Alef Connect mobile network in the Quickstart Guide.

The API environments

There are currently 3 API environments:

• Production You will use this when you go live with your Alef Edge Platform.
• Sandbox This is where you can try out our APIs. To get access to the Sandbox environment, just go to https://www.alefedge.com/, click REQUEST A DEMO, and fill out the form.
• PoC This will become available to customers in the near future. It will consist of a fully functioning test environment.

Network Setup API

note

• When using the Production environment to place an order, there will be a 10 minute window where you can change your order details, during which time the order will be in RECEIVED state. Once the 10 minutes elapses, the order state will change to PROCESSING, and any further attempt to change to your order using the API will fail with a valid order not found message.
• When using the Sandbox environment, the behavior will be similar, but the window where you can change your order details will only be 1 minute.

Use this API to

• Create order

• Get all your orders

• Get Order Provisioning Details by order ID

• Update order

• Cancel order

Account Management API

Use this API to:

• Get account details

• Update Account Details

• Create/Add Customer Site Address

• Get all customer site details

• Get Customer Site details Address ID

• Update Customer Site

• Delete Customer Site

SIM Management API

Use this API to:

• Get all your SIM details

• Get SIM status

• Manage SIM status

Reporting API

• Reporting API (Refer to the Reporting Guide for more information)