Skip to main content

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.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for sdksio-verizon-apis-sdk 2.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sdksio-verizon-apis-sdk 2.0.0
File Size Uploaded Provenance Actions
sdksio_verizon_apis_sdk-2.0.0.tar.gz 419.1 kB Without provenance Details for sdksio_verizon_apis_sdk-2.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sdksio-verizon-apis-sdk 2.0.0
File Interpreter ABI Platform Actions
sdksio_verizon_apis_sdk-2.0.0-py3-none-any.whl Python 3 none any Details for sdksio_verizon_apis_sdk-2.0.0-py3-none-any.whl

Total release size: 1.7 MB

Release files / sdksio_verizon_apis_sdk-2.0.0.tar.gz

Download URL sdksio_verizon_apis_sdk-2.0.0.tar.gz
Size 419.1 kB
Tags Source
SHA-256 checksum
How to use checksums
1790d98d3494573db44ab1867148deb049aa26a32ac2f1da4d91595ad179f524
BLAKE2b-256 checksum
How to use checksums
627fc087e9098028b76bccba163d7add964a203fdcfd4fb5ba9f5d4135b4566b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / sdksio_verizon_apis_sdk-2.0.0-py3-none-any.whl

Download URL sdksio_verizon_apis_sdk-2.0.0-py3-none-any.whl
Size 1.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
cc0a08d3d620131391d012ec00a1f509dc354012adb9feeb940b6c212f099caa
BLAKE2b-256 checksum
How to use checksums
eac06ff5db5c94ca48eb5992b42853141bea74d386a7bb61eded90faf3cb500b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for sdksio-verizon-apis-sdk 2.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page