Authentication

Mosaic API

The Mosaic API is designed for robust and flexible integration capabilities. It supports simultaneous multi-instance integration and is platform-independent, ensuring compatibility with any API-enabled platform.

Getting Started

  1. Obtain an API Key

To start, reach out to your Mosaic Customer Success Manager to request an API Key. You'll need to provide:

  • The domain from which your server makes API calls.
  • The Webhook URL to receive callbacks. Mosaic recommends using HTTPS for secure callbacks. If your service requires HTTP, please specify this in your Webhook URL.

All REST API endpoints require an API Key in the request header for authorization.

Important: If you misplace your API Key, promptly contact your Customer Success Manager for a new one. Issuing a new key does not automatically deactivate any previous keys. If you need to deactivate an API key, please let us know.

  1. API Key Provisioning

Upon your request, your Customer Success Manager will provide you with an API Key.

Using the API Key

API requests need your team id and API Key. Use your team id in the request header:

Example: /api/{team_id}/{data_type}

Add your API Key and Origin (given with the API Key) in the request header:

Authorization = {api_key}
Origin = {domain}

Note: Your origin should match the domain or the base of your Webhook URL (excluding the final /webhook). For example, if your Webhook URL is myCoolApp.com/api/webhook, your origin is myCoolApp.com/api.

API Rate Limit

The Mosaic API has a rate limit in place to ensure fair usage and maintain optimal performance for all users. The rate limit for Mosaic is set at 300 requests per 5 minutes, which averages to 1 request per second.

This means that you can make up to 300 requests to the Mosaic API within a 5-minute window. If you exceed this limit, you may receive a rate limit error response. It's important to manage your requests and ensure they stay within the specified limits to avoid disruptions in service.

Please note that the rate limit is subject to change based on system conditions and usage patterns. We recommend periodically checking our documentation for any updates or announcements regarding rate limit adjustments.

API Access for Single Tenant Customers

Single tenant customers will receive a unique API server URL, distinct from the common URL in our standard documentation. Please use the provided URL for your environment to ensure seamless integration and complete access to our tailored API services.