neutrino-api-sdk 1.0.0

This is a POC created by APIMatic for Neutrino API

Getting Started with Neutrino API

Introduction

The general-purpose API

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install neutrino-api-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/neutrino-api-sdk/1.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.MULTICLOUD
http_client_instance	HttpClient	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']
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
user_id_credentials	UserIdCredentials	The credential object for Custom Header Signature
api_key_credentials	ApiKeyCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

client = NeutrinoapiClient(
    user_id_credentials=UserIdCredentials(
        user_id='user-id'
    ),
    api_key_credentials=ApiKeyCredentials(
        api_key='api-key'
    ),
    environment=Environment.MULTICLOUD,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environments

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

Fields

Name	Description
Multicloud	Default
AWS	-
GCP	-
Backup	-
EU	-
AUS	-
USA	-

Authorization

This API uses the following authentication schemes.

• user-id (Custom Header Signature)
• api-key (Custom Header Signature)

List of APIs

• Data Tools
• Securityand Networking
• Imaging
• Telephony
• Geolocation
• E-Commerce
• WWW

SDK Infrastructure

Configuration

• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime