API Reference

Test Environment (QA)

Test applications and APIs in a production-like environment without consequences.

Overview

PlanOmatic's QA environment is a production-like copy of our platform where you can exercise the V3 Order API and PlanOintegrate without creating real work. Access is granted on request: email [email protected] and we will set up your QA integration and API key. There is no self-serve sandbox.

📘

QA is separate from production

Your QA API key is different from your production key. QA accounts, integrations and keys can be reset when the environment is refreshed from production, so if a QA key stops working, ask us to re-issue it.

QA URLs

# Order API
https://api.planomatic.com/api/v3/orders/create      # Production
https://api.qa.planomatic.com/api/v3/orders/create   # QA

# PlanOintegrate
https://integrate.planomatic.com      # Production
https://integrate.qa.planomatic.com   # QA

What You Can Test on QA

  • Create, retrieve and cancel orders with the V3 Order API, including the validation errors.
  • Manage a webhook subscription in PlanOintegrate and read its delivery log.
  • Receive order.canceled: create a QA order, cancel it through the Cancel Order API, and observe the webhook at your endpoint and in the PlanOintegrate log.

QA has no PlanOtechs or production team, so a QA order cannot be driven through scheduling, post-processing or order.delivered.

How Can I Test Webhooks With Live Data?

The best way to test your webhook consumer is with real order updates. In your production PlanOintegrate account, create an additional webhook subscription that points at your test environment. It receives the same events as your production subscription, so your team can build and verify the consumer against live orders without touching your production endpoint. Deactivate the subscription when you are done.