README

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

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "sdksio/verizon-apis-sdk:2.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "sdksio/verizon-apis-sdk": "2.0.0"
}

You can also view the package at: https://packagist.org/packages/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`
timeout	`int`	Timeout for API calls in seconds. Default: `0`
enableRetries	`bool`	Whether to enable retries and backoff feature. Default: `false`
numberOfRetries	`int`	The number of retries to make. Default: `0`
retryInterval	`float`	The retry time interval between the endpoint calls. Default: `1`
backOffFactor	`float`	Exponential backoff factor to increase interval between retries. Default: `2`
maximumRetryWaitTime	`int`	The maximum wait time in seconds for overall retrying requests. Default: `0`
retryOnTimeout	`bool`	Whether to retry on request timeout. Default: `true`
httpStatusCodesToRetry	`array`	Http status codes to retry against. Default: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`
httpMethodsToRetry	`array`	Http methods to retry against. Default: `'GET', 'PUT'`
proxyConfiguration	`ProxyConfigurationBuilder`	Represents the proxy configurations for API calls
thingspaceOauthCredentials	`ThingspaceOauthCredentials`	The Credentials Setter for OAuth 2 Client Credentials Grant
vZM2mTokenCredentials	`VZM2mTokenCredentials`	The Credentials Setter for Custom Header Signature
sessionTokenCredentials	`SessionTokenCredentials`	The Credentials Setter for Custom Header Signature
thingspaceOauth1Credentials	`ThingspaceOauth1Credentials`	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

use VerizonLib\Environment;
use VerizonLib\Authentication\ThingspaceOauthCredentialsBuilder;
use VerizonLib\Authentication\VZM2MTokenCredentialsBuilder;
use VerizonLib\Authentication\SessionTokenCredentialsBuilder;
use VerizonLib\Authentication\ThingspaceOauth1CredentialsBuilder;
use VerizonLib\VerizonClientBuilder;

$client = VerizonClientBuilder::init()
    ->thingspaceOauthCredentials(
        ThingspaceOauthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->vZM2mTokenCredentials(
        VZM2MTokenCredentialsBuilder::init(
            'VZ-M2M-Token'
        )
    )
    ->sessionTokenCredentials(
        SessionTokenCredentialsBuilder::init(
            'SessionToken'
        )
    )
    ->thingspaceOauth1Credentials(
        ThingspaceOauth1CredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->build();

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	-

sdksio / verizon-apis-sdk

Maintainers

Package info

Statistics

Security

README

Introduction

Install the Package

Initialize the API Client

Environments

Fields

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities