Skip to main content

Getting Started with NewStore API

Introduction

NewStore public APIs

Install the Package

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

pip install newstore-apimatic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/newstore-apimatic-sdk/0.0.1

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
tenant str Default: "dodici"
environment Environment The API environment.
Default: Environment.STAGING
http_client_instance Union[Session, HttpClientProvider] 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"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
client_credentials_auth_credentials ClientCredentialsAuthCredentials The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

Code-Based Client Initialization

from newstoreapi.configuration import Environment
from newstoreapi.http.auth.o_auth_2 import ClientCredentialsAuthCredentials
from newstoreapi.models.o_auth_scope_enum import OAuthScopeEnum
from newstoreapi.newstoreapi_client import NewstoreapiClient

client = NewstoreapiClient(
    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret',
        o_auth_scopes=[
            OAuthScopeEnum.CATALOGIMPORT_SCHEMASREAD,
            OAuthScopeEnum.CATALOGIMPORT_SCHEMASWRITE
        ]
    ),
    environment=Environment.STAGING,
    tenant='dodici'
)

Environment-Based Client Initialization

from newstoreapi.newstoreapi_client import NewstoreapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = NewstoreapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

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

Fields

Name Description
STAGING Default

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for newstore-apimatic-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for newstore-apimatic-sdk 0.0.1
File Size Uploaded Provenance Actions
newstore_apimatic_sdk-0.0.1.tar.gz 428.8 kB Without provenance Details for newstore_apimatic_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for newstore-apimatic-sdk 0.0.1
File Interpreter ABI Platform Actions
newstore_apimatic_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for newstore_apimatic_sdk-0.0.1-py3-none-any.whl

Total release size: 1.6 MB

Release files / newstore_apimatic_sdk-0.0.1.tar.gz

Download URL newstore_apimatic_sdk-0.0.1.tar.gz
Size 428.8 kB
Tags Source
SHA-256 checksum
How to use checksums
47583165c9855c66c3beb46cd3b2643e90f7c670c34497b34928ac885d8df906
BLAKE2b-256 checksum
How to use checksums
44fd033843345b57527a6c0e6af2fc9ca175379eb8f681321992ecc15ca7afaa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / newstore_apimatic_sdk-0.0.1-py3-none-any.whl

Download URL newstore_apimatic_sdk-0.0.1-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b9ff9efeb443d25999b3f0f2272558689a9300a099d1f76d246e0c17b45dfdd8
BLAKE2b-256 checksum
How to use checksums
f56f023ddc0a1809c02be3350bc695ce276c52ff69d867d3643cc2dfc3d1ca51
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for newstore-apimatic-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page