Skip to main content

Getting Started with Stax (FattMerchant) API

Introduction

API specification auto-generated from Laravel route definitions. Base URL: https://apiprod.fattlabs.com All routes require JWT authentication unless otherwise noted.

Install the Package

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

pip install apimatic-stax-sdk==0.0.2

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

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.PRODUCTION
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: 30
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.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
bearer_auth_credentials BearerAuthCredentials The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from staxfattmerchantapi.configuration import Environment
from staxfattmerchantapi.http.auth.oauth_2 import BearerAuthCredentials
from staxfattmerchantapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from staxfattmerchantapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from staxfattmerchantapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from staxfattmerchantapi.staxfattmerchantapi_client import StaxfattmerchantapiClient

client = StaxfattmerchantapiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from staxfattmerchantapi.staxfattmerchantapi_client import StaxfattmerchantapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = StaxfattmerchantapiClient.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
PRODUCTION Default Production
ENVIRONMENT2 Development

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-stax-sdk 0.0.2

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

Source distribution (sdist)

Source distribution for apimatic-stax-sdk 0.0.2
File Size Uploaded Provenance Actions
apimatic_stax_sdk-0.0.2.tar.gz 36.1 kB Without provenance Details for apimatic_stax_sdk-0.0.2.tar.gz

Built distribution (wheel)

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

Total release size: 159.2 kB

Release files / apimatic_stax_sdk-0.0.2.tar.gz

Download URL apimatic_stax_sdk-0.0.2.tar.gz
Size 36.1 kB
Tags Source
SHA-256 checksum
How to use checksums
5561ac1710ef299597c4802d7da28de399f73afbf4b424c03af471e5f56f9f27
BLAKE2b-256 checksum
How to use checksums
a8c8eab6c21d916279ba19f916898d3620f26be900a6c796817edf114d3ca388
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / apimatic_stax_sdk-0.0.2-py3-none-any.whl

Download URL apimatic_stax_sdk-0.0.2-py3-none-any.whl
Size 123.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0e9460a1bf0745ac0706fbc7cf0e91b91b6efe3f68dd032ad3f4047d91f60b86
BLAKE2b-256 checksum
How to use checksums
0d7206b5dfaf183f82f51baacd55fbf65fafa35c04c2d8e4e2ce896f50c898c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-stax-sdk 0.0.2

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.2 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