Environments & access

Deal Engine's GraphQL API runs in more than one environment. This page is the canonical reference for what those environments are called, what each one can and can't do, and how to get access to them. If you read nothing else on this page, read the disambiguation immediately below.

"Sandbox" means two different things here

You can point the Apollo Sandbox tool at the Deal Engine sandbox environment, or at Production; the tool doesn't decide which; the URL you paste into it does. Conflating the two is the most common way integrators end up running a "test" query against Production. See Getting started §1.3 for the same warning in context, and How to test in other environments for how to drive Apollo Sandbox itself once you know which URL to give it.

Canonical environment names

The rest of this documentation set uses exactly two names: Production and Sandbox.

🚧

Point your first calls at Sandbox, not Production. A refund submitted against Production executes against a real, live ticket. See the Quickstart for a full runnable path against Sandbox.

API endpoints by tenant

Deal Engine runs two tenants; US and EU. Each customer is provisioned on one tenant and uses that tenant's Production/Sandbox pair consistently; the two tenants are not interchangeable.

The OnePoint web UI follows the same tenant/environment pattern:

Schema source of truth

The schema itself is defined by GraphQL introspection against your environment's endpoint; there is no separately maintained schema document. Authenticate first: unauthenticated introspection only shows the role-aware auth operations (e.g. login); the full schema for your role appears once you add the Authorization header and refresh. See How to test in other environments for the exact steps.

Aliases you'll encounter

"Sandbox" is the name this documentation set uses consistently. Elsewhere in the docs, and in some tooling, the same (or a closely related) environment goes by other names. Until confirmed otherwise, treat the ones below as referring to the Sandbox environment above, but note the open questions.

🚧

"stage" is not this Sandbox. If you encounter onepoint.stage.deal-engine.com in older material, that is an internal staging deployment of OnePoint; the customer-facing OnePoint hosts are the four in the table above. Don't let "stage" in a OnePoint URL be mistaken for a GraphQL environment name.

What Sandbox can and cannot exercise

Full detail: Testing & environments and Refund lifecycle & statuses §3.3.

Can validate:

• API contract; request/response shapes match the documented schema
• Quote amounts; fare, taxes, penalties, fees for your test tickets
• Decision logic; approvals/rejections against your configured rules
• Candidate status flow up to READY
• Webhook delivery for quote-stage events (refund_request.status_updated)

Cannot validate:

• The REFUNDED terminal status; fulfillment doesn't run in Sandbox
• PSS coupon status transitions
• BSP settlement
• Final executed amounts; Production recalculates tax/penalty and applies FX at execution time; see Refund amounts & reconciliation

Apollo Sandbox availability per environment

How to test in other environments describes two ways to open the tool: a built-in landing page at the GraphQL endpoint itself (Option A), or the hosted Apollo Sandbox pointed at your endpoint (Option B); whichever is enabled for the environment you're targeting.

Either way, the authentication and schema-refresh steps are the same and are already covered in that guide; this page only tells you which URL to give it.

Webhooks across environments

Configure webhook endpoints per environment; a delivered event's environment field tells you which one fired it (production or staging; see the alias note above). Deal Engine's own recommended practice is to configure and test webhooks in the non-production environment first. See the Webhook API reference and the Webhooks guide.

Next step

Ready to make your first call? The Quickstart walks through authenticate → quote → read → decide → refund → track, entirely against Sandbox.