Getting Started with Verizon

Introduction

The Verizon Edge Discovery Service API can direct your application clients to connect to the optimal service endpoints for your Multi-access Edge Computing (MEC) applications for every session. The Edge Discovery Service takes into account the current location of a device, its IP anchor location, current network traffic and other factors to determine which 5G Edge platform a device should connect to.

Verizon Terms of Service: https://www.verizon.com/business/5g-edge-portal/legal.html

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "4-g/4-g-specs-sdk:1.3.0"

Or add it to the composer.json file manually as given below:

"require": {
    "4-g/4-g-specs-sdk": "1.3.0"
}

You can also view the package at: https://packagist.org/packages/4-g/4-g-specs-sdk#1.3.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
vZM2mToken	string	M2M Session Token (How to generate an M2M session token?)
environment	Environment	The API environment. Default: Environment.PRODUCTION
timeout	int	Timeout for API calls in seconds. Default: 0
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
oauth2Credentials	Oauth2Credentials	The Credentials Setter for OAuth 2 Client Credentials Grant
thingspaceOauthCredentials	ThingspaceOauthCredentials	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

$client = VerizonClientBuilder::init()
    ->oauth2Credentials(
        OAuth2CredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oauthScopes(
                [
                    OauthScopeOauth2Enum::DISCOVERYREAD,
                    OauthScopeOauth2Enum::SERVICEPROFILEREAD
                ]
            )
    )
    ->thingspaceOauthCredentials(
        ThingspaceOauthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->vZM2mToken('VZ-M2M-Token')
    ->environment('Production')
    ->build();

API calls return an ApiResponse object that includes the following fields:

Field	Description
getStatusCode	Status code of the HTTP response
getHeaders	Headers of the HTTP response as a Hash
getResult	The deserialized body of the HTTP response as a String

Authorization

This API uses the following authentication schemes.

• oAuth2 (OAuth 2 Client Credentials Grant)
• thingspace_oauth (OAuth 2 Client Credentials Grant)

List of APIs

• 5G Edge Platforms
• Service Endpoints
• Service Profiles
• Device Management
• Device Groups
• Session Management
• Connectivity Callbacks
• Account Requests
• Service Plans
• Device Diagnostics
• Device Profile Management
• Device Monitoring
• E UICC Device Profile Management
• Devices Locations
• Devices Location Subscriptions
• Device Location Callbacks
• Usage Trigger Management
• Software Management Subscriptions V1
• Software Management Licenses V1
• Firmware V1
• Software Management Callbacks V1
• Software Management Reports V1
• Software Management Subscriptions V2
• Software Management Licenses V2
• Campaigns V2
• Software Management Callbacks V2
• Software Management Reports V2
• Client Logging
• Server Logging
• Configuration Files
• Software Management Subscriptions V3
• Software Management Licenses V3
• Campaigns V3
• Software Management Reports V3
• Firmware V3
• Account Devices
• Software Management Callbacks V3
• SIM Securefor Io T Licenses
• Account Subscriptions
• Performance Metrics
• Diagnostics Subscriptions
• Diagnostics Observations
• Diagnostics History
• Diagnostics Settings
• Diagnostics Callbacks
• Diagnostics Factory Reset
• Cloud Connector Subscriptions
• Cloud Connector Devices
• Device Service Management
• Device Reports
• Hyper Precise Location Callbacks
• Anomaly Settings
• Anomaly Triggers
• Anomaly Triggers V2
• Wireless Network Performance
• Fixed Wireless Qualification
• Managinge SIM Profiles
• Device SMS Messaging
• Device Actions
• Thing Space Qualityof Service API Actions
• Promotion Period Information
• Retrievethe Triggers
• Update Triggers
• SIM Actions
• Global Reporting
• OAuth Authorization
• Accounts
• SMS
• Exclusions
• Billing
• Targets
• MEC

Classes Documentation

• Utility Classes
• ApiException
• HttpRequest
• HttpResponse