mistapi-go

module
v0.4.26 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 27, 2024 License: MIT

README

Getting Started with Mist API

Introduction

Version: 2412.1.11

Date: December 27, 2024

Additional Documentation
Helpful Resources
Requirements

The SDK requires Go version 1.18 or above.

Building

Install Dependencies

Resolve all the SDK dependencies, using the go get command.

Installation

The following section explains how to use the mistapi library in a new project.

1. Add SDK as a Dependency to the Application
  • Add the following lines to your application's go.mod file:
replace mistapi => ".\\mist-api-go_generic_lib" // local path to the SDK

require mistapi v0.0.0
  • Resolve the dependencies in the updated go.mod file, using the go get command.

Test the SDK

Go Testing is used as the testing framework. To run the unit tests of the SDK, navigate to the root directory of the SDK and run the following command in the terminal:

$ go test

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.MIST_GLOBAL_01
httpConfiguration HttpConfiguration Configurable http client options like timeout and retries.
loggerConfiguration LoggerConfiguration Represents the logger configurations for API calls
apiTokenCredentials ApiTokenCredentials The Credentials Setter for Custom Header Signature
basicAuthCredentials BasicAuthCredentials The Credentials Setter for Basic Authentication
csrfTokenCredentials CsrfTokenCredentials The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

client := mistapi.NewClient(
    mistapi.CreateConfiguration(
        mistapi.WithHttpConfiguration(
            mistapi.CreateHttpConfiguration(
                mistapi.WithTimeout(0),
            ),
        ),
        mistapi.WithEnvironment(mistapi.MIST_GLOBAL_01),
        mistapi.WithApiTokenCredentials(
            mistapi.NewApiTokenCredentials("Authorization"),
        ),
        mistapi.WithBasicAuthCredentials(
            mistapi.NewBasicAuthCredentials(
                "Username",
                "Password",
            ),
        ),
        mistapi.WithCsrfTokenCredentials(
            mistapi.NewCsrfTokenCredentials("X-CSRFToken"),
        ),
        mistapi.WithLoggerConfiguration(
            mistapi.WithLevel("info"),
            mistapi.WithRequestConfiguration(
                mistapi.WithRequestBody(true),
            ),
            mistapi.WithResponseConfiguration(
                mistapi.WithResponseHeaders(true),
            ),
        ),
    ),
)

Environments

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

Fields
Name Description
Mist Global 01 Default
Mist Global 02 -
Mist Global 03 -
Mist Global 04 -
Mist EMEA 01 -
Mist EMEA 02 -
Mist EMEA 03 -
Mist APAC 01 -

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation

Directories

Path Synopsis
errors
models
sdk module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.