Apiamtic.SubtainVer 1.6.9

Getting Started with Verizon 5G MEC VNSP API

Introduction

The API helps manage or use MEC platform hosted services.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package Apiamtic.SubtainVer --version 1.6.9

You can also view the package at: https://www.nuget.org/packages/Apiamtic.SubtainVer/1.6.9

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

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:

Verizon5GMECVNSPAPI.Standard.Verizon5GMECVNSPAPIClient client = new Verizon5GMECVNSPAPI.Standard.Verizon5GMECVNSPAPIClient.Builder()
    .OAuthScopes(new List<OAuthScopeEnum>() { OAuthScopeEnum.TsMecFullaccess })
    .ClientCredentialsAuth("OAuthClientId", "OAuthClientSecret")
    .VZM2MToken("VZ-M2M-Token")
    .Environment(Verizon5GMECVNSPAPI.Standard.Environment.Production)
    .Build();

Environments

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

Fields

Authorization

This API uses OAuth 2 Client Credentials Grant.

Client Credentials Grant

Your application must obtain user authorization before it can execute an endpoint call in case this SDK chooses to use OAuth 2.0 Client Credentials Grant. This authorization includes the following steps

The FetchToken() method will exchange the OAuth client credentials for an access token. The access token is an object containing information for authorizing client requests and refreshing the token itself.

You must have initialized the client with scopes for which you need permission to access.

var authManager = client.ClientCredentialsAuth;

try
{
    OAuthToken token = authManager.FetchToken();
    // re-instantiate the client with OAuth token
    client = client.ToBuilder().OAuthToken(token).Build();
}
catch (ApiException e)
{
    // TODO Handle exception
}

The client can now make authorized endpoint calls.

Scopes

Scopes enable your application to only request access to the resources it needs while enabling users to control the amount of access they grant to your application. Available scopes are defined in the OAuthScopeEnum enumeration.

Storing an access token for reuse

It is recommended that you store the access token for reuse.

// store token
SaveTokenToDatabase(client.ClientCredentialsAuth.OAuthToken);

Creating a client from a stored token

To authorize a client from a stored access token, just set the access token in Configuration along with the other configuration parameters before creating the client:

// load token later
OAuthToken token = LoadTokenFromDatabase();

// Provide token along with other configuration properties while instantiating the client
Verizon5GMECVNSPAPIClient client = client.ToBuilder().OAuthToken(token).Build();

Complete example

using Verizon5GMECVNSPAPI.Standard;
using Verizon5GMECVNSPAPI.Standard.Models;
using Verizon5GMECVNSPAPI.Standard.Exceptions;
using Verizon5GMECVNSPAPI.Standard.Authentication;
using System.Collections.Generic;
namespace OAuthTestApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            Verizon5GMECVNSPAPI.Standard.Verizon5GMECVNSPAPIClient client = new Verizon5GMECVNSPAPI.Standard.Verizon5GMECVNSPAPIClient.Builder()
                .OAuthScopes(new List<OAuthScopeEnum>() { OAuthScopeEnum.TsMecFullaccess })
                .ClientCredentialsAuth("OAuthClientId", "OAuthClientSecret")
                .VZM2MToken("VZ-M2M-Token")
                .Environment(Verizon5GMECVNSPAPI.Standard.Environment.Production)
                .Build();
            try
            {
                OAuthToken token = LoadTokenFromDatabase();

                // Set the token if it is not set before
                if (token == null)
                {
                    var authManager = client.ClientCredentialsAuth;
                    token = authManager.FetchToken();
                }

                SaveTokenToDatabase(token);
                client = client.ToBuilder().OAuthToken(token).Build();
            }
            catch (OAuthProviderException e)
            {
                // TODO Handle exception
            }
        }

        //function for storing token to database
        static void SaveTokenToDatabase(OAuthToken token)
        {
            //Save token here
        }

        //function for loading token from database
        static OAuthToken LoadTokenFromDatabase()
        {
            OAuthToken token = null;
            //token = Get token here
            return token;
        }
    }
}

// the client is now authorized and you can use controllers to make endpoint calls

List of APIs

• Service Onboarding
• Service Metadata
• CSP Profiles
• Service Claims
• O Auth Authorization
• Repositories

Classes Documentation

• Utility Classes
• HttpRequest
• HttpResponse
• HttpStringResponse
• HttpContext
• HttpClientConfiguration
• HttpClientConfiguration Builder
• IAuthManager
• ApiException