README

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 "sdksio/verizon-apis-sdk:1.3.0"

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

"require": {
    "sdksio/verizon-apis-sdk": "1.3.0"
}

You can also view the package at: https://packagist.org/packages/sdksio/verizon-apis-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'`
`clientCredentialsAuth`	`ClientCredentialsAuth`	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

$client = VerizonClientBuilder::init()
    ->clientCredentialsAuthCredentials(
        ClientCredentialsAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oauthScopes(
                [
                    OauthScopeEnum::DISCOVERYREAD,
                    OauthScopeEnum::SERVICEPROFILEREAD
                ]
            )
    )
    ->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

sdksio / verizon-apis-sdk

Maintainers

Details

README

Introduction

Install the Package

Initialize the API Client

Authorization

List of APIs

Classes Documentation