Meevo Public API

https://docs.meevoapi.com
Admin
Meevo Public API allows developers to retrieve, post, update, and delete data in Meevo salon and spa...
Tokens:2,671
Snippets:18
Trust Score:7.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### Meevo Public API Endpoints Overview

Source: https://docs.meevoapi.com/index

This section details all Public API endpoints available in Meevo, grouped by Read (GET) and Write (PUT, UPDATE, DELETE) operations. Pagination is handled via 'ItemsPerPage' and 'PageNumber'.

```APIDOC
## Meevo Public API Endpoints

### Description
The collections below detail all Public API endpoints available in Meevo. Endpoints are grouped by Read (GET) and Write (PUT, UPDATE, DELETE).

For Pagination, each page displays the number of results (**ItemsPerPage**) starting on the defined **PageNumber**.

### Method
GET, PUT, UPDATE, DELETE

### Endpoint
(Details for specific endpoints are not provided in the input text)

### Parameters
#### Query Parameters
- **ItemsPerPage** (integer) - Description of how many items to return per page.
- **PageNumber** (integer) - Description of the page number to retrieve.

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### Maintenance Windows

Source: https://docs.meevoapi.com/index

Meevo maintenance runs nightly from 12 AM to 6 AM, potentially causing service interruptions or slowdowns. Maintenance start times are based on cluster time zones (e.g., NA0: EST, NA1: PST).

```APIDOC
## Maintenance Windows

### Description
Meevo maintenance runs every night from 12 midnight to 6 am. During this time there may be an interruption of service, but in most cases the system will just be slower than usual. Additional details can be found in the **Maintenance of Services** section of our Terms of Service.

The maintenance window start time is based on the time zone of your cluster (NA0, NA1, etc.):
- NA0: EST (Eastern Standard Time)
- NA1: PST (Pacific Standard Time)
- NA2: EST
- CA0: EST
- UK1: United Kingdom time

### Method
N/A (Informational)

### Endpoint
N/A (Informational)

### Parameters
N/A (Informational)

### Request Example
N/A (Informational)

### Response
N/A (Informational)
```

--------------------------------

### Authentication - Request Access Token

Source: https://docs.meevoapi.com/index

Obtain a JSON Web Token (JWT) for authenticating API calls by POSTing your appId and appSecret to the Marketplace endpoint.

```APIDOC
## POST /oauth2/token

### Description
Requests a JSON Web Token (JWT) for authenticating API calls. This token is required for all subsequent API interactions.

### Method
POST

### Endpoint
https://d18devmarketplace.meevodev.com/oauth2/token

### Parameters
#### Request Body
- **client_id** (string) - Required - Your unique application ID (AppId).
- **client_secret** (string) - Required - Your unique application secret (AppSecret).

### Request Example
```json
{
  "client_id": "AppId",
  "client_secret": "AppSecret"
}
```

### Response
#### Success Response (200)
- **access_token** (string) - The JWT for authentication.
- **token_type** (string) - The type of token, typically 'Bearer'.
- **expires_in** (integer) - The token's validity period in seconds.
- **scope** (string) - The scope granted by the token.

#### Response Example
```json
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIm",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "meevo:scope"
}
```
```

--------------------------------

### Overages and Rate Limiting

Source: https://docs.meevoapi.com/index

Each location has a daily limit of 1000 calls, with charges for exceeding this limit. A maximum of 5000 calls per day is enforced, and the API rate limit is 60 calls per minute. Higher limits require contacting MSI.

```APIDOC
## Overages and Rate Limiting

### Description
Each location is allotted 1000 calls per day. Charges are incurred for each call beyond the initial 1000 per day. There is a maximum of 5000 calls permitted in a given day. Additional calls beyond the 5000 are rejected until the next day when the counter resets. The Meevo Public API rate limit is 60 calls per minute. For a higher call rate limit, contact your MSI representative for options and pricing. All Meevo API calls are subject to rate limits. MSI reserves the right to adjust the rate limit for a given endpoint to ensure a high quality service for all Meevo Public API users.

### Best Practices to Avoid Rate Limiting
- **Cache data that changes infrequently**: Make calls only when data is needed. Cache relatively static data and reference it locally. If a non-matching GUID is encountered, make the appropriate call and cache the response.
- **Remove unnecessary API calls**: Optimize code to ensure each call is for relevant, immediately needed data.
- **Regulate your request rate**: Distribute requests evenly over time (e.g., using throttling) to avoid regularly reaching the rate limit.

### Method
N/A (Informational)

### Endpoint
N/A (Informational)

### Parameters
N/A (Informational)

### Request Example
N/A (Informational)

### Response
N/A (Informational)
```

--------------------------------

### Requesting an Access Token (JWT) via cURL

Source: https://docs.meevoapi.com/index

This snippet demonstrates how to obtain a JSON Web Token (JWT) for authenticating API calls. It requires your unique appId and appSecret, passed as client_id and client_secret in the request body. The JWT is returned in the response and must be included as a Bearer Token in subsequent API requests.

```cURL
curl -X POST https://d18devmarketplace.meevodev.com/oauth2/token \
-H "Content-Type: application/json" \
-d '{
  "client_id": "YourAppId",
  "client_secret": "YourAppSecret"
}'
```

--------------------------------

### Session Patching (Changing Locations)

Source: https://docs.meevoapi.com/index

When changing locations within a tenant, a new JWT specific to the new location is issued. Caching tokens and matching cache expiration to token expiration is recommended to prevent repeated authorization or session patch calls.

```APIDOC
## Session Patching (Changing Locations)

### Description
When you change locations within a tenant, the system will issue a new JWT specific to that new location. To prevent repeated authorization calls or session patch calls when switching between locations, it is recommended to cache each token received and ensure that the cache expiration matches the expiration of the token.

### Method
(Not specified, likely POST or PUT for patching)

### Endpoint
(Not specified)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### Access Token Response Structure

Source: https://docs.meevoapi.com/index

This JSON structure represents the successful response when requesting an access token (JWT). It includes the access token itself, its type, expiration time in seconds, and the granted scope. This token is essential for authenticating all subsequent API calls.

```json
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIm",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "meevo:scope"
}
```
Tokens:
Raw