sdksio-verizon-apis-sdk

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 sdksio-verizon-apis-sdk -v 1.7.0

Or add the gem to your Gemfile and run bundle:

gem 'sdksio-verizon-apis-sdk', '1.7.0'

For additional gem details, see the RubyGems page for the sdksio-verizon-apis-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
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.
thingspace_oauth_credentials	ThingspaceOauthCredentials	The credential object for OAuth 2 Client Credentials Grant
vz_m2m_token_credentials	VZM2mTokenCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

client = Verizon::Client.new(
  thingspace_oauth_credentials: ThingspaceOauthCredentials.new(
    oauth_client_id: 'OAuthClientId',
    oauth_client_secret: 'OAuthClientSecret',
    oauth_scopes: [
      OauthScopeThingspaceOauthEnum::DISCOVERYREAD,
      OauthScopeThingspaceOauthEnum::SERVICEPROFILEREAD
    ]
  ),
  vz_m2m_token_credentials: VZM2mTokenCredentials.new(
    vz_m2m_token: 'VZ-M2M-Token'
  ),
  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

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
Production	Default
Mock server for limited availability, see quick start	-

Authorization

This API uses the following authentication schemes.

• thingspace_oauth (OAuth 2 Client Credentials Grant)
• VZ-M2M-Token (Custom Header Signature)

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
• 5G BI Device Actions
• Accounts
• SMS
• Exclusions
• Billing
• Targets
• PWN
• V2 Triggers

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest