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

Install the gem from the command line:

gem install specs-sdk -v 1.3.0

Or add the gem to your Gemfile and run bundle:

gem 'specs-sdk', '1.3.0'

For additional gem details, see the RubyGems page for the specs-sdk gem.

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`	`String`	M2M Session Token (How to generate an M2M session token?)
`environment`	`Environment`	The API environment. Default: `Environment.PRODUCTION`
`connection`	`Faraday::Connection`	The Faraday connection object passed by the SDK user for making requests
`adapter`	`Faraday::Adapter`	The Faraday adapter object passed by the SDK user for performing http requests
`timeout`	`Float`	The value to use for connection timeout. Default: 60
`max_retries`	`Integer`	The number of times to retry an endpoint call if it fails. Default: 0
`retry_interval`	`Float`	Pause in seconds between retries. Default: 1
`backoff_factor`	`Float`	The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2
`retry_statuses`	`Array`	A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
`retry_methods`	`Array`	A list of HTTP methods to retry. Default: %i[get put]
`http_callback`	`HttpCallBack`	The Http CallBack allows defining callables for pre and post API calls.
`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 = Verizon::Client.new(
  vz_m2m_token: 'VZ-M2M-Token',
  oauth_2credentials: Oauth2Credentials.new(
    oauth_client_id: 'OAuthClientId',
    oauth_client_secret: 'OAuthClientSecret',
    oauth_scopes: [
      OauthScopeOauth2Enum::DISCOVERYREAD,
      OauthScopeOauth2Enum::SERVICEPROFILEREAD
    ]
  ),
  thingspace_oauth_credentials: ThingspaceOauthCredentials.new(
    oauth_client_id: 'OAuthClientId',
    oauth_client_secret: 'OAuthClientSecret'
  ),
  environment: Environment::PRODUCTION
)

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 Hash
`raw_body`	The body of the HTTP response as a String
`request`	HTTP request info
`errors`	Errors, if they exist
`data`	The deserialized body of the HTTP response

itsAdee / 4-g-specs-ruby-sdk

Getting Started with Verizon

Introduction

Install the Package

Initialize the API Client

Authorization

List of APIs

Classes Documentation

About

Languages