Scope
This document explains how to use the Beeks Portal to manage your Beeks services. Its purpose is to explain how the user can take advantage of the different features of the Portal.
There are two ways to access information about your services: via the Portal and via an Application Programming Interface (API). The Portal is a user interface that you can open in the browser, while the API is used by software integrations to send and receive information about your services.
This document is not an API reference guide, but some references are included to particular endpoint names in order to help readers relate the concepts in this guide to the Portal API. The Portal API itself is fully documented in the Portal API Reference.
Audience
The intended audience for this document is any user of the Beeks Portal.
Styling Conventions used in this Document
When this document refers to an API endpoint, it adopts a different formatting (of which this is an example). Users who only use the User Interface can ignore these references.
Connect > Create a Cross Connect. This indicates a sequence of expandable menu items to follow to reach the desired item (Create a Cross Connect in this case). Each > indicates that the item is a sub-item of the one preceding it.
Feedback
We welcome feedback on our documentation. Please report suggestions, omissions and errors to documentation@beeksgroup.com.
Related documents
Document name | Document reference | Description |
|---|---|---|
Description of Proximity Cloud, its features, benefits, and most common packages. | ||
Description of Exchange Cloud, its features, benefits, and most common packages. | ||
Reference guide for developers wishing to use the Portal API. | ||
Proximity Cloud: API Worked Examples | BKDI004 | Worked examples of combinations of API calls that achieve particular business goals. Can be a useful companion document to this document and to the Portal API Reference. |
Portal User Guide for Proximity Cloud & Exchange Cloud Users | BKDI002 | User Guide for the elements of the Portal that are specific to Proximity Cloud and Exchange Cloud users. Note that tenants of Proximity Cloud availability zones will find all of the information that we need within the current document - they don’t need to consult BKDI002. |
BKDA001 | Overview of the features supported by Beeks Analytics. A subset of these features is made available as part of the standard Proximity Cloud and Exchange Cloud offering. | |
BKDA002 | This document describes the data and metrics available for use in Beeks Analytics templated deployments. This initial version of the document focuses on the data and metrics that are available as part of the Beeks Analytics for Markets template. The BAM template is also used for Beeks Analytics within Proximity Cloud and Exchange Cloud deployments. | |
BKDA004 | User Guide for Beeks Analytics VMX-Explorer analytics, monitoring, and visualisation tool. |