Navigating our API

Introduction

Alef has created the Private Edge Developer Portal to facilitate a rich Developer Community bringing revolutionary 5G-like services to market today. Alef offers APIs at every layer of their Edge Stack across all Alef Products for Developers to leverage when creating these 5G-like services. This document will present a step-by-step walk-through for Private Edge Developer Account Creation as well as creating Subscriptions on the Developer Private Edge Portal. Furthermore, there are links provided to documents detailing the procedures for the configuration of a Subscription, usage of a Subscription, and the testing of Subscriptions directly in this document.

Private Edge Developer Account Creation

The first step in the account creation process is to go to the public developer landing page. The public developer landing page’s URL is, developer.alefedge.com

Begin Sign up Process

Once on the Home Page of the Private Edge Developer Portal there is a horizontal navigation bar present for easy access through the Webpage. Click the “Sign Up” button, the third option, to continue the Workflow.

Enter Profile Information

Fill out the data fields provided and upload a profile picture, limited to 2MB, to personalize your Private Edge Developer Portal Space. All required fields are denoted by an asterisk. Once completed, the “Next” button will turn cyan in the bottom right, click to continue. The profile picture is not mandatory, it is recommended to make the space feel more like your own.

Confirm Account Details

Please ensure all information entered is correct and click the cyan “Next” button in the bottom right corner.

Create Account

To finalize account creation, agree to the Alef Acceptable Usage Policy and Alef Privacy Policy by clicking the checkboxes to the left of the respective documents, complete the reCAPTCHA activity and click “Create Account”. The account creation workflow will continue via an email to the address entered.

Verify Email Address

After completing account creation, an Email will be in the inbox of the address provided. Click the hyperlink to verify the email address and confirm the account creation. If the hyperlink is not working, please copy and paste the provided URL into the browser’s URL bar.

Set Password

Once the email address has been verified, a page will render in order to set a password. The password must be at least 8 characters in length with 1 capital letter, 1 lower case letter, 1 number, and 1 symbol, full requirements can be seen by hovering over the red “i” icon. Click the “Update Password” button to complete the account creation process and receive your final confirmation email.

Explore the Edge!

After a password has been set, a final confirmation email containing the username and API key associated with your account will be present in the inbox of the provided email address. Sign up for a subscription and start exploring the Edge today.

Create a Service

In order to create a service, all Developers must first create their Developer Private Edge Portal account. Please go back to section two and follow that workflow if you have not already done so. This workflow will assume the user is logged into and the user is currently on the Developer Private Edge Home Page. Please note the Alef 5G Video Services Product will be used as an example but this process can be replicated for any of Alef’s Products.

Select a Product

The create a service workflow will begin from the Private Edge Developer Portal Home Page. From the Home Page, please click “Products” from the Horizontal Navigation Bar. Clicking “Products” will reveal a drop down please click the Product to be subscribed to. Alternatively, the “+” sign in the “My Services” Box on the Home Page will reveal a Product list. Clicking the Product, you would like to subscribe to will also push the workflow forward.

Add a Service Page Navigation

Once the Product is selected from the dropdown, the “Overview” page for the selected Product will render. From the “Overview Page”, select “Pricing” from the Vertical Navigation Bar on the left side of the page. If you clicked the “+” button from the Home Page, this step is skipped.

Subscribe to a Service

On the “Add a Service” page, the first step is to select the Developer Private Edge Location in the closest proximity. The Location dropdown is on the top right of the page under the Horizontal Navigation Bar. Once a Location is selected, a free Subscription option should appear. Click “Purchase” at the bottom of the Subscription tile.

Confirm Service Details

Once the free subscription has been purchased. A screen for confirmation of Subscription details will appear. The Product, Location, and Plan information will all be preloaded onto the page. The user will be required to fill in a unique service name. Once completed, the user will have to click confirm to finalize subscription creation. It is important to note you will immediately be brought to the Configuration page for the newly subscribed service. Instructions on how to Navigate to this page are included below. As a check, the service should now be visible on the user’s Private Edge Developer Home Page.

Service Configuration

Once a subscription to an Alef service has been confirmed, the developer must configure their service prior to interacting with any Alef 5G Edge APIs. After confirming a subscription the Developer will be taken to the Configure page. The configure page is within the service management section of the Developer Portal. There are instructions on how to get to this section below the “Configure a Service” section of this document

 

Configure a Service

After creating and confirming either your Alef 5G Video Services or 5G Video Notifications, the following step in this workflow to Configure the Service. “Configure” is an option on the Subscription Management Page. The following sections will highlight the process for the individual services.

Alef 5G Video Enablement Configuration

For full details on the configuration of the Alef 5G Video Enablement service, please use the following document:

https://developer.alefedge.com/reference-docs/private-edge-developer-portal/service-usage-docs/configure-a-service-video-enablement/

Alef 5G Video Notification Configuration

For full details on the configuration of the Alef 5G Video Notification service, please use the following document:

https://developer.alefedge.com/reference-docs/private-edge-developer-portal/service-usage-docs/configure-a-service-video-notifications/

Service Management Navigation

There are additional tools provided to the subscribed Developer for end-to-end control and view of their Subscription. Select “My Private Edge” from the Horizontal Navigation bar and then “My Services” from the subsequent drop-down menu. This will take the user to an overview page of all the Subscriptions possessed.

On the Services overview page, in each individual row, furthest to the right there is a button provided for ease of navigation. The button will take the user to the analytics page of the management section. From there, all additional management processes are provided. In addition to the Configuration Page, the following actions are also available:

  • Content Analytics
  • API Documentation
  • Sandbox Environment for Testing
  • API Analytics
  • Logging and Debugging

 

Service API Usage

Once a service has been configured, the Developer is ready to start building and leveraging Alef 5G Edge services.

Alef 5G Video Enablement API Usage

For a greater understanding of how to use the 5G Video Enablement Service APIs, please read the following document:

https://developer.alefedge.com/reference-docs/private-edge-developer-portal/service-usage-docs/api-usage-5g-video-enablement/

Alef 5G Video Notifications API Usage

For a better understanding of how to use the 5G Video Enablement Service APIs, please read the following document:

https://developer.alefedge.com/reference-docs/private-edge-developer-portal/service-usage-docs/api-usage-5g-video-notifications/

Service Testing

Alef has deployed Developer Private Edge Test Environments at 2 U.S. Edge Locations and 1 India Edge Location so far with more to come. We are working hard to increase the number of Edge Locations in additional major metropolitan areas around the world. While we continue to expand these numbers, please feel free to request a Sandbox at one of our existing locations to test Edge Services. If there is any question on how to request and interact with the Developer Sandbox Environment, please view the following document: https://developer.alefedge.com/managing-your-apps-and-services/debugging-and-testing/sandbox-tutorial/.

How useful was this post?

We are sorry that this post was not useful for you!

Let us improve this post!

Tell us how we can improve this post?