Getting Started with MINDBODY Public API

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

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 | | --- | --- | --- | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | customHeaderAuthenticationCredentials | CustomHeaderAuthenticationCredentials | The credential object for customHeaderAuthentication |

The API client can be initialized as follows:

Code-Based Client Initialization

import { Client } from 'mb-apimatic-sdk';

const client = new Client({
  customHeaderAuthenticationCredentials: {
    'API-Key': 'API-Key'
  },
  timeout: 0,
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'mb-apimatic-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'mb-apimatic-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.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

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError