Skip to main content

Migrate to the new platform

What's New?​

The new Pleevi platform introduces several improvements designed to make your integration smoother, more reliable, and scalable:

  • Multiple environments: Access both Production and Sandbox environments. Safely test new features in Sandbox, and securely rely on stable optimizations in Production.
  • API-based configuration: Use our Site Management API to automatically onboard and maintain sites directly from your tooling.
  • Optimization settings: Easily configure optimization preferences (e.g., day-ahead forecasts, peak limits) via the portal or API.
  • Pleevi Web Portal: Self-service portal to configure and maintain your sites.
  • Validations: The platform automatically validates site configurations to ensure they are ready for optimization.
  • Optimization history: Inspect past optimizations and analyze how they have evolved over time.
  • Activate/Deactivate sites: Manage site availability with simple activation and deactivation controls.

Multiple Environments​

You will receive credentials for both the Sandbox and Production environments:

  • Sandbox
    Intended for testing purposes only.
    We do not guarantee the same stability as Production. Sandbox is isolated, allowing you to experiment safely without polluting production data.

  • Production
    For operational use only.
    Production data is persisted and directly used for generating optimizations. Never use Production for testing purposes.

tip

Use the Sandbox environment during development and testing. It is fully isolated and helps prevent accidental data pollution in production.

caution

Do not use Production to test new integrations. All data sent to Production is stored and used for actual optimizations.

API-based Configuration​

The new platform introduces a Site Management API, allowing you to automate the onboarding and maintenance of sites through your existing tooling.

info

If you rather rely on a pre made configuration dashboard, don't worry we got you covered, checkout https://portal.pleevi.ai!

MQTT Configuration​

MQTT Broker URLs​

Publish messages to our new MQTT broker: mqtt://mqtt.pleevi.ai

Authentication​

You will receive new credentials, one for each environment (Sandbox & Production).

New MQTT Topics​

We've redesigned the MQTT topic structure to improve clarity, scalability, and separation of concerns.

Ingress Topics (Incoming Data)​

Our ingress topics have changed with the goal of splitting up the asset data from other (site related) data we send over mqtt. This change will require an update in the devices sending data to these topics.

Old topic structure:

v2/[partner_id]/[site_id]/[asset_id]/energyMeasurement
v2/[partner_id]/[site_id]/[asset_id]/transaction

New topic structure:

# Production
prd/v2/[partner_id]/[site_id]/asset/[asset_id]/transaction
prd/v2/[partner_id]/[site_id]/asset/[asset_id]/energyMeasurement

# Sandbox
sbx/v2/[partner_id]/[site_id]/asset/[asset_id]/energyMeasurement
sbx/v2/[partner_id]/[site_id]/asset/[asset_id]/transaction

Egress Topics (Outgoing Data)​

Old topic structure:

v2/[partner_id]/advice

New topic structure:

# Production
prd/v2/[partner_id]/[site_id]/asset/[asset_id]/advice
prd/v2/[partner_id]/[site_id]/notification (NEW)

# Sandbox
sbx/v2/[partner_id]/[site_id]/asset/[asset_id]/advice
sbx/v2/[partner_id]/[site_id]/notification (NEW)
info

Why Did We Change the Topic Structure?​

  • To gain better visibility over what is being published.
  • To prevent topic interference, which was a limitation of the old structure.
  • To clearly separate asset data from site-wide notifications.
  • To enable logical separation between Sandbox and Production, making testing safer and more convenient.

✅ Migration Checklist​

Before going live:

  • Obtain your new Sandbox and Production credentials.
  • Configure separate MQTT clients for Sandbox and Production.
  • Update MQTT hosts to the new broker URLs.
  • Update all ingress topics and egress topic subscriptions to the new structure. If you still want all advices in one connection, you can listen to prd/v2/[partner_id]/+/asset/+/advice
  • Switch your site onboarding flow to use the Site Management API.
  • Validate your integration in Sandbox before going live on Production.

If you have any questions or need assistance during the migration, feel free to contact us at support@pleevi.ai.