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

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install 4-g-specs-sdk==1.3.0

You can also view the package at: https://pypi.python.org/pypi/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
`vz_m2m_token`	`str`	M2M Session Token (How to generate an M2M session token?)
`environment`	`Environment`	The API environment. Default: `Environment.PRODUCTION`
`http_client_instance`	`HttpClient`	The Http Client passed from the sdk user for making requests
`override_http_client_configuration`	`bool`	The value which determines to override properties of the passed Http Client from the sdk user
`http_call_back`	`HttpCallBack`	The callback value that is invoked before and after an HTTP call is made to an endpoint
`timeout`	`float`	The value to use for connection timeout. Default: 60
`max_retries`	`int`	The number of times to retry an endpoint call if it fails. Default: 0
`backoff_factor`	`float`	A backoff factor to apply between attempts after the second try. Default: 2
`retry_statuses`	`Array of int`	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
`retry_methods`	`Array of string`	The http methods on which retry is to be done. Default: ['GET', 'PUT']
`oauth_2_credentials`	`Oauth2Credentials`	The credential object for OAuth 2 Client Credentials Grant
`thingspace_oauth_credentials`	`ThingspaceOauthCredentials`	The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

client = VerizonClient(
    vz_m2m_token='VZ-M2M-Token',
    oauth_2_credentials=Oauth2Credentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_scopes=[
            OauthScopeOauth2Enum.DISCOVERYREAD,
            OauthScopeOauth2Enum.SERVICEPROFILEREAD
        ]
    ),
    thingspace_oauth_credentials=ThingspaceOauthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret'
    )
)

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

Field	Description
`status_code`	Status code of the HTTP response
`reason_phrase`	Reason phrase of the HTTP response
`headers`	Headers of the HTTP response as a dictionary
`text`	The body of the HTTP response as a string
`request`	HTTP request info
`errors`	Errors, if they exist
`body`	The deserialized body of the HTTP response

itsAdee / 4-g-specs-python-sdk

Getting Started with Verizon

Introduction

Install the Package

Initialize the API Client

Authorization

List of APIs

Classes Documentation

About

Languages