Skip to main content

Getting Started with MINDBODY Public 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 mb-apimatic-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/mb-apimatic-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
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.
custom_header_authentication_credentials CustomHeaderAuthenticationCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

from mindbodypublicapi.configuration import Environment
from mindbodypublicapi.http.auth.custom_header_authentication import CustomHeaderAuthenticationCredentials
from mindbodypublicapi.mindbodypublicapi_client import MindbodypublicapiClient

client = MindbodypublicapiClient(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        api_key='API-Key'
    ),
    environment=Environment.PRODUCTION
)

Environment-Based Client Initialization

from mindbodypublicapi.mindbodypublicapi_client import MindbodypublicapiClient

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

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for mb-apimatic-sdk 1.0.0

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

Source distribution (sdist)

Source distribution for mb-apimatic-sdk 1.0.0
File Size Uploaded Provenance Actions
mb_apimatic_sdk-1.0.0.tar.gz 352.4 kB Without provenance Details for mb_apimatic_sdk-1.0.0.tar.gz

Built distribution (wheel)

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

Total release size: 1.1 MB

Release files / mb_apimatic_sdk-1.0.0.tar.gz

Download URL mb_apimatic_sdk-1.0.0.tar.gz
Size 352.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a820a520c87f0a6a0ef72668a1ff3d040d61d8b1a1c8863b7fd83688610d005b
BLAKE2b-256 checksum
How to use checksums
13222128184430c8c0c998b5dd5deb9ec18f4622079fd1fb4603ed0259266889
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / mb_apimatic_sdk-1.0.0-py3-none-any.whl

Download URL mb_apimatic_sdk-1.0.0-py3-none-any.whl
Size 775.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e8eebc1c6d0a740701fb7d236bb86c66aaf52607e6b47935d8c00d93877710fd
BLAKE2b-256 checksum
How to use checksums
3f716eebfeb448570438a35d5d77f1ad852be302c908fcb6dafff0430b3010a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for mb-apimatic-sdk 1.0.0

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

1.0.0 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