Skip to content

Environments & Base URLs

This page defines the officially supported environments, their base URLs, and any region/network constraints. If something is intentionally unspecified, it is marked UNCONFIRMED with a target posture.

Supported environments

EnvironmentStatusNotes
prodSupportedPublic integration surface on custom domains. All published docs and MCP refer to this environment.
sandboxUNCONFIRMEDNot publicly advertised. Target posture: optional shared sandbox with rate limits and isolated data.
stagingUNCONFIRMEDInternal-only validation environment if/when needed.
devUNCONFIRMEDDeveloper-only/local; no public guarantees.

If you need a sandbox or staging environment, coordinate with the g3n team. Until explicitly published, assume prod is the only external environment.

Canonical base URLs (prod)

InterfaceBase URLNotes
API Gatewayhttps://api.g3nretailstack.com/<service>Primary external HTTP surface.
Docshttps://doc.g3nretailstack.com/Human-readable docs.
MCP protocol docshttps://mcp.g3nretailstack.com/<service>/PROTOCOL.mdCanonical MCP protocol docs (mirrored to docs host).
MCP API endpointhttps://api.mcp.g3nretailstack.com/mcpHTTP JSON-RPC MCP endpoint (no SSE transport; clients send Accept: application/json, text/event-stream).

Service-specific bases (examples): https://api.g3nretailstack.com/uas, /usm, /ofm, /pvm, /pmc, /ics, /scm, /pcm, /ppm, /crm, /influencer, /accounting, /ipm, /rbs, /utl, /mrs, /ops, /ucp, /slc, /visualgrid.

Region constraints

  • Single-region: us-east-1 only (confirmed).
  • Multi-region: UNCONFIRMED. Target posture: multi-region read scale and regional failover only after explicit production cutover.

Clients do not choose regions today; all endpoints are global custom domains that resolve to us-east-1.

Network controls (WAF / allowlist)

  • AWS WAF is active on all 21 API Gateway stages and all 4 CloudFront distributions.
  • REGIONAL WebACL (g3nretailstack-shared-waf): protects all /service/* API endpoints on api.g3nretailstack.com.
  • CLOUDFRONT WebACL (g3nretailstack-cloudfront-waf): protects doc.g3nretailstack.com, app.g3nretailstack.com, mcp.g3nretailstack.com, visualgrid.g3nretailstack.com.
  • Rules: AWS Managed Rules (Common Rule Set, Known Bad Inputs, IP Reputation List) + per-IP rate limit (2,000 req/5min for API, 5,000 req/5min for CloudFront).
  • WAF 403 responses have no JSON body — distinguish from application 403 by checking for a JSON error object.
  • IP allowlisting is available on request for high-volume integrations or dedicated partner IPs. Contact support to coordinate.

How to verify environment

  • The docs footer shows the current build_id and build timestamp for the published environment.
  • API responses include stats.build.build_id, stats.build.build_major, stats.build.build_minor to correlate calls with published docs.