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.

Where there is some information which is particularly important to communicate, but which may easily be missed, we use this format to display it.

Proximity Cloud > Rack Overview. This indicates a sequence of expandable menu items to follow to reach the desired item (Rack Overview 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

Beeks Document reference

Description

Portal API Reference

n/a

Reference guide for developers wishing to use the Portal API

Technical Deployment Guide for Proximity Cloud & Exchange Cloud

BKDI002

Guide for connecting to and setting up Proximity or Exchange Cloud. Helps users to understand how these products can be integrated with the customer’s own or other third-party networks.

Portal User Guide

BKDI003

User guide for how to use the Portal to manage any Beeks service (not specific to Proximity Cloud).

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.