Skip to main content

​
Overview

Partoo provides two separate environments:
  • Sandbox – a safe space to build and test new integrations.
  • Production – the live environment where real data and customers are affected.
Always begin in Sandbox, validate your workflow end-to-end, and then request Production access.
Sandbox is empty by default and offers only a subset of features. Populate test data or use mocks as needed.

​
Missing features in the Sandbox

The Sandbox environment is designed for safe testing and does not support all production features. Notably disabled features include:
  • Address geocoding
  • Publishing to Google, Facebook, and other platforms
  • Importing Google or Facebook listings
  • Access to live reviews or analytics data
You can manually populate your test environment with sample data.
Contact your Account Manager to request additional sandbox capabilities.

​
Prerequisites

  • A Partoo Account Manager assigned to your organisation
  • Network access to *.partoo.co domains

​
Quick start

1

Obtain your Sandbox API key

Contact your Partoo Account Manager and ask for a Sandbox API key.
​
x-APIKey
string
required
Pass your Sandbox API key in every request header.
All API calls that omit the x-APIKey header return 401 Unauthorized.
2

Test API routes in Sandbox

Test calling an endpoint to ensure your sandbox key works correctly. Use our interactive API Reference Docs to test endpoints individually with ease.
cURL
curl --location 'https://api.sandbox.partoo.co/v2/business/search' \ 
  --header 'x-APIKey: SANDBOX_API_KEY'
A 200 OK response confirms that your key is valid and that the route is available to your user.
3

(Optional) Request UI access

If you need to inspect data or configure settings via the web app, ask your Account Manager to create a Sandbox user for you.
UI access is not required for API-only integrations.
4

Prepare your integration for production

Iterate until all test scenarios succeed in Sandbox. Remove test data and ensure idempotent behaviour.
Keep environment variables such as BASE_URL and API_KEY separate so you can switch contexts without code changes.
Explore Partoo’s capabilitiesBefore starting to build your integration, take time to understand the full scope of what Partoo offers:
  • API Fundamentals – Learn how to use the Partoo API effectively and efficiently.
  • Structures – Learn how Partoo organizes data hierarchically (Organizations, Groups, Businesses)
  • Roles – Understand user permissions and access levels within the platform
  • Use Cases – Discover the many ways you can leverage Partoo’s API for location management, review handling, messaging, and so on.
Understanding these fundamentals will help you design a more robust integration that takes full advantage of Partoo’s features.
5

Generate your Production API key

Once you’re confident that your integration is production-ready, contact your Partoo Account Manager to request user access in Production and access to the API Key Manager tool. Within the Partoo Web Application, you can then generate and manage your own API Keys.
To know more about generating and managing your own API Keys, please refer to the API Keys Generation guide.
cURL
curl --location 'https://api.partoo.co/v2/business/search' \ 
  --header 'x-APIKey: SANDBOX_API_KEY'
Successful calls against the Production endpoint indicate that your integration is live.