DedicatedNetwork API description

DedicatedNetwork API description

API description

The Dedicated Network APIs provide functionalities for reserving network connectivity resources, selecting network capabilities, and controlling access for devices.

With this API, developers can

  • reserve network connectivity resources (e.g. throughput) potentially with an Service Level Agreement (including terms and conditions for using the service) and for service time and location (service area) limits,

  • discover supported and prepared network capabilities/resources (e.g. existing slices to connect to)

  • manage device access, offering insights based on network profiles and resource states.

These estimations/data points are derived from anonymized historical data of provided networks and related connected devices in the requested area (e.g. network slices and connectivity monitoring), ensuring accuracy while maintaining privacy and security.

The Dedicated Networks APIs consist of three APIs, the Dedicated Network API, the Dedicated Network Accesses API and the Dedicated Network Profiles API. This document describes the Dedicated Network API. Detailed information about the APIs and its usage can be found here.

A Dedicated Network is a logical resource and is used to embody the reservation of network connectivity resources in the physical network. Initiating a new reservation request using this API results in a new Dedicated Network resource being created. The Dedicated Network undergoes various lifecycle States including REQUESTED, RESERVED, ACTIVATED and TERMINATED. Reservation of resources occurs based on the selected Network Profile, duration when the reservation is needed (Service Time) and geographical areas where the service is needed (Service Area).

Key Features:

  • Network reservation management: Creating, querying and deleting a Network.

  • Notification Support: Receive status change notifications via a callback URL.

  • Predefined Network Profiles: Choose from a set of ore-defined Network profiles tailored.

  • Time and location limited network reservation: The network is only available within the reserved time window and within the reserved geographical areas.

Use Cases

The Dedicated Network API is versatile and can be applied to various scenarios where network performance is critical:

  • Media Production – The Dedicated Networks API ensures stable connectivity performance for a camera crew during a press briefing event. The API Consumer can dynamically adjust the Quality of Service (QOS) profiles for each camera (need based), providing higher quality and QOS for the live camera and lower quality for standby cameras. This allows the media producer to manage video production efficiently, ensuring seamless live streaming.

  • Festival – The Dedicated Networks API provides stable connectivity for operating Point of Sale devices (e.g. credit card readers) and CCTV cameras at a festival. The API allows the festival organizer to either statically assign a QOS profile to a device or allow switching between different QOS profiles, e.g. ensuring high-quality video for security purposes and reliable payment processing. This helps in managing the festival operations smoothly without interruptions.

  • Enterprise – The Dedicated Networks API connects employees' devices to corporate services with varying QOS profiles. During virtual meetings, the API supports high-quality video and audio streams, enhancing the meeting experience. It ensures secure access to corporate services and manages the needed capacity efficiently.

  • Emergency Services – The Dedicated Networks API offers reliable communication and data services for emergency responders. It ensures they have the necessary information and connectivity during critical situations, improving response times and coordination.

  • Smart Cities – The Dedicated Networks API supports intelligent transport systems, public safety, and other smart city applications. It provides the necessary connectivity and data services to enhance urban living and operational efficiency.

  • Airports – The Dedicated Networks API is used for video surveillance, asset tracking, and real-time data analytics in airports. It enhances security and operational efficiency by providing reliable connectivity for various airport applications.

  • Mining – The Dedicated Networks API supports remote control of machinery, environmental monitoring, and predictive maintenance in the mining industry. It ensures safe and efficient mining operations with constant connectivity.

  • Manufacturing and Logistics – The Dedicated Networks API enables the use of Automated Guided Vehicles (AGVs), robots, and drones for efficient operations in manufacturing and logistics. It supports asset tracking and real-time data analytics, improving operational efficiency.

  • Ports – The Dedicated Networks API facilitates the management of logistics and supply chains in ports. It ensures smooth operations and tracking of assets with reliable connectivity.

  • Oil & Gas – The Dedicated Networks API is used for environmental monitoring, asset tracking, and ensuring safety in oil and gas operations. It provides the necessary connectivity for critical applications in the industry.

  • Utilities – The Dedicated Networks API supports the monitoring and management of utility services. It enhances reliability and efficiency by providing constant connectivity for various utility applications.

  • Rail – The Dedicated Networks API is used for asset tracking, remote control of machinery, and real-time data analytics in rail operations. It improves safety and efficiency with reliable connectivity.

  • Healthcare – The Dedicated Networks API ensures secure and reliable connectivity for life-saving systems and medical devices in hospitals. It supports critical healthcare applications, enhancing patient care and operational efficiency.

  • Public Venues – The Dedicated Networks API provides predictable connectivity and enhanced security for various applications in large public venues like stadiums and convention centers. It ensures smooth operations and reliable connectivity for event management.

  • Industrial Applications – The Dedicated Networks API supports robotics, automated inventory control, and other industrial applications that require constant connectivity and low latency. It enhances operational efficiency and reliability in industrial settings.

  • Transportation and Logistics – The Dedicated Networks API facilitates the tracking and management of assets in transportation and logistics. It ensures efficient operations with reliable connectivity for various logistics applications.

Benefits

Using the Dedicated Network API offers several advantages for developers and end-users:

  • Enhanced User Experience: Allow reservation of connectivity performance within specific time durations and at specific locations

  • Improved Connectivity: Ensures dedicated throughput for specific devices, enhancing network reliability

  • Optimized Network Usage: Allows selection and discovery of network capabilities, improving resource utilization.

  • Enhanced Security: Controls device access to reserved resources, ensuring secure and managed connectivity.

  • Higher Efficiency: Enhances operational efficiency by supporting various applications with reliable connectivity.