sdksio/verizon-apis-sdk

Use the Verizon API for connectivity management, device diagnostics, device location, edge discovery service, edge performance, software management and much more.

1.5.1 2024-10-25 07:21 UTC

This package is auto-updated.

Last update: 2024-10-25 07:21:54 UTC


README

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

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

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

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

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

You can also view the package at: https://packagist.org/packages/sdksio/verizon-apis-sdk#1.5.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

$client = VerizonClientBuilder::init()
    ->thingspaceOauthCredentials(
        ThingspaceOauthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oauthScopes(
                [
                    OauthScopeThingspaceOauthEnum::DISCOVERYREAD,
                    OauthScopeThingspaceOauthEnum::SERVICEPROFILEREAD
                ]
            )
    )
    ->vZM2mTokenCredentials(
        VZM2MTokenCredentialsBuilder::init(
            'VZ-M2M-Token'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->build();

API calls return an ApiResponse object that includes the following fields:

Environments

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

Fields

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation