diff --git a/.claude/rules/openapi.md b/.claude/rules/openapi.md index 18a6d24..068a0d0 100644 --- a/.claude/rules/openapi.md +++ b/.claude/rules/openapi.md @@ -77,8 +77,14 @@ machine-checkable subset. - `/v1` is a **header selector** (`X-Trace-Version: 1`). It is **never** a URL path segment. Do not write paths like `/api/v1/...`. -- Server URL is per-service: `https://faas.{env}.tracefinance.io/account`, - `/payment`, `/webhook`. +- Server URL is the bare gateway host. Only the sandbox host is + published: `https://api.sandbox.tracefinance.com`. The production + host is **not** documented publicly — it is shared with the customer + at go-live. Do **not** add a production `servers:` entry, a + `productionUrl` Mintlify variable, or any production URL in MDX. +- Do **not** include the internal service segment (`/account`, + `/payment`, `/webhook`) — service names are not exposed publicly. + Paths begin at the source channel (`/api/...`). - Strip `/dashboard` and `/admin` paths — only `/api` channel is documented. Public discovery endpoints (e.g., `/references/...`) sit outside `/api` and require no auth — set diff --git a/apis/fx-account/openapi.yml b/apis/fx-account/openapi.yml index f4084bd..911b11c 100644 --- a/apis/fx-account/openapi.yml +++ b/apis/fx-account/openapi.yml @@ -4,10 +4,8 @@ info: version: 1.0.0 description: API for managing multi-currency accounts on the Trace FX platform. servers: - - url: https://faas.sandbox.tracefinance.io/account + - url: https://api.sandbox.tracefinance.com description: Sandbox - - url: https://faas.tracefinance.io/account - description: Production security: - bearerAuth: [] tags: diff --git a/apis/fx-payment/openapi.yml b/apis/fx-payment/openapi.yml index 683da86..09f1f39 100644 --- a/apis/fx-payment/openapi.yml +++ b/apis/fx-payment/openapi.yml @@ -6,10 +6,8 @@ info: API for deposits, withdrawals, swaps, and beneficiary management on the Trace FX platform. servers: - - url: https://faas.sandbox.tracefinance.io/payment + - url: https://api.sandbox.tracefinance.com description: Sandbox - - url: https://faas.tracefinance.io/payment - description: Production security: - bearerAuth: [] tags: diff --git a/apis/fx-webhook/openapi.yml b/apis/fx-webhook/openapi.yml index 9c8e134..97fad92 100644 --- a/apis/fx-webhook/openapi.yml +++ b/apis/fx-webhook/openapi.yml @@ -6,10 +6,8 @@ info: API for managing webhook subscriptions and inspecting webhook delivery history on the Trace FX platform. servers: - - url: https://faas.sandbox.tracefinance.io/webhook + - url: https://api.sandbox.tracefinance.com description: Sandbox - - url: https://faas.tracefinance.io/webhook - description: Production security: - bearerAuth: [] tags: diff --git a/docs.json b/docs.json index 0545612..a02191f 100644 --- a/docs.json +++ b/docs.json @@ -246,18 +246,14 @@ ] }, "api": { - "baseUrl": [ - "https://faas.sandbox.tracefinance.io", - "https://faas.tracefinance.io" - ], + "baseUrl": "https://api.sandbox.tracefinance.com", "auth": { "method": "bearer" } }, "description": "Explore guides, examples, and API references to build with Trace Finance.", "variables": { - "sandboxUrl": "https://faas.sandbox.tracefinance.io", - "productionUrl": "https://faas.tracefinance.io", + "sandboxUrl": "https://api.sandbox.tracefinance.com", "authUrl": "https://auth.tracefinance.io" }, "seo": { diff --git a/guides/environments.mdx b/guides/environments.mdx index bffe9f4..3e27fa9 100644 --- a/guides/environments.mdx +++ b/guides/environments.mdx @@ -7,10 +7,7 @@ description: "Sandbox and production base URLs, and what differs between them." Trace FX provides two environments. Use sandbox for development and testing, and production for live integrations. -| Environment | Base URL | -| --- | --- | -| Sandbox | `{{sandboxUrl}}` | -| Production | `{{productionUrl}}` | +The sandbox base URL is `{{sandboxUrl}}`. The production base URL is shared with you at go-live, after your integration has been validated in sandbox. ## Details diff --git a/webhooks/test-in-sandbox.mdx b/webhooks/test-in-sandbox.mdx index 95c26ad..6ab60b4 100644 --- a/webhooks/test-in-sandbox.mdx +++ b/webhooks/test-in-sandbox.mdx @@ -7,7 +7,7 @@ description: "Develop and verify webhook handlers against the Trace sandbox." The sandbox environment delivers real webhook events as you exercise the API — creating orders, registering beneficiaries, initiating PIX payments, and so on. Use it to develop and test your handler before going to production. -The sandbox base URL is `{{sandboxUrl}}` (`https://faas.sandbox.tracefinance.io`). +The sandbox base URL is `{{sandboxUrl}}`. ## Recommended workflow