mb-apimatic-sdk 1.0.0

MB apimatic SDK

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.

• API-Key (Custom Header Signature)

List of APIs

• Appointment
• Class
• Client
• Cross Site
• Enrollment
• Payroll
• Pick a Spot
• Pricing Option
• Sale
• Site
• Staff
• User Token

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime