Getting Started with Verizon

Introduction

"The Connection Planner is a service that provides devices windows to connect to their backend APIs. The service validates device access permissions and processes valid devices asynchronously. For each batch, it retrieves device connectivity windows from the RAN KPI Data Application, and sends callbacks back to customers via UWS-Callback for both successful and failed device requests."

Best Practices for Callbacks: https://thingspace.verizon.com/documentation/apis/connectivity-management/working-with-verizon/about-callback-services/best-practices.html

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install sdksio-verizon-apis-sdk==2.0.0

You can also view the package at: https://pypi.python.org/pypi/sdksio-verizon-apis-sdk/2.0.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
environment	Environment	The API environment. Default: Environment.PRODUCTION
http_client_instance	Union[Session, HttpClientProvider]	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"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
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
session_token_credentials	SessionTokenCredentials	The credential object for Custom Header Signature
thingspace_oauth_1_credentials	ThingspaceOauth1Credentials	The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

Code-Based Client Initialization

from verizon.configuration import Environment
from verizon.http.auth.session_token import SessionTokenCredentials
from verizon.http.auth.thingspace_oauth import ThingspaceOauthCredentials
from verizon.http.auth.thingspace_oauth_1 import ThingspaceOauth1Credentials
from verizon.http.auth.vz_m2m_token import VZM2mTokenCredentials
from verizon.verizon_client import VerizonClient

client = VerizonClient(
    thingspace_oauth_credentials=ThingspaceOauthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret'
    ),
    vz_m2m_token_credentials=VZM2mTokenCredentials(
        vz_m2m_token='VZ-M2M-Token'
    ),
    session_token_credentials=SessionTokenCredentials(
        session_token='SessionToken'
    ),
    thingspace_oauth_1_credentials=ThingspaceOauth1Credentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret'
    ),
    environment=Environment.PRODUCTION
)

Environment-Based Client Initialization

from verizon.verizon_client import VerizonClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = VerizonClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

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

Fields

Name	Description
PRODUCTION	Default
STAGING	-
DEV	-
QA	-
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)
• sessionToken (Custom Header Signature)
• thingspace_oauth1 (OAuth 2 Client Credentials Grant)

List of APIs

• Account Service Controller
• Intelligence Service Controller
• Device Management
• Device Groups
• Session Management
• Connectivity Callbacks
• Account Requests
• Service Plans
• Device Diagnostics
• Device Monitoring
• Device Profile Management
• 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
• Diagnostics Subscriptions
• Diagnostics Observations
• Diagnostics History
• Diagnostics Settings
• Diagnostics Callbacks
• Diagnostics Factory Reset
• Cloud Connector Subscriptions
• Cloud Connector Devices
• HPL Device Management
• Device Service Management
• Device Reports
• Hyper Precise Location Callbacks
• Device Credential Management
• Anomaly Settings
• Anomaly Triggers
• Anomaly Triggers V2
• Wireless Network Performance
• 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
• Map Data Manager
• Retrieve Rate Plan List
• Create Price Plan Triggers
• Update Price Plan Triggers
• 5G BI Device Actions
• Sensor Insights Sensors
• Sensor Insights Devices
• Sensor Insights Gateways
• Sensor Insights Smart Alerts
• Sensor Insights Rules
• Sensor Insights Health Score
• Sensor Insights Notification Groups
• Sensor Insights Users
• Sensor Insights Device Profile
• Sensor Insights Smart Alert Metrics
• API
• Accounts
• SMS
• Exclusions
• Billing
• Targets
• PWN
• Device-Role-Controller

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime