docs(api): SEO metadata + all-corridor updates for AI-agent page and integration skill#1266
Open
ebma wants to merge 2 commits into
Open
docs(api): SEO metadata + all-corridor updates for AI-agent page and integration skill#1266ebma wants to merge 2 commits into
ebma wants to merge 2 commits into
Conversation
…orridors - Record per-page Apidog SEO settings (metaTitle, metaDescription, keywords) in page-manifest.json and document the convention in the docs README; values are applied manually in the Apidog UI. - De-BRL the AI Agent Integration page: state that all live corridors (BRL, EUR, USD, MXN, COP, ARS) are supported on every integration path and rewrite the fiat-settlement section per corridor. - Bring the vortex-integration skill up to date with the SDK: EUR/SEPA and USD/MXN/COP/ARS recipes, taxId deprecation, submitUserTransactions and listAlfredpayFiatAccounts, new error classes, and fix the sandbox base URL (api-sandbox.vortexfinance.co).
✅ Deploy Preview for vortex-sandbox ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for vortexfi ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…iming Verified against the API backend (staging and main): - Ramp registration requires a user-linked sk_* key in every corridor; partner keys without a user binding are rejected. Fix the auth page, corridors page, and quick start, which still claimed partner-scoped keys suffice for BRL/EUR with taxId identifying the user. - BRL taxId is an optional cross-check against the account's derived tax ID; drop it from the quick-start examples. - Quote response uses flattened fee fields (networkFeeFiat, totalFeeFiat, feeCurrency, *Usd twins), not a nested fee object; rewrite the sample on the quotes page. - depositQrCode/ibanPaymentData are released after presigned txs validate (update response / GET ramp), not on register; document on the lifecycle and AI-agent pages. - Generalize remaining BRL-only wording on the overview and lifecycle pages; whitelabel provider names on the KYB page. - Skill: EUR register gate returns 503 while quotes still succeed; webhook transactionType values are BUY/SELL; partner-scoped keys cannot register ramps.
Member
Author
|
Second commit: swept the remaining doc pages against the API backend code (staging and main) and fixed everything that had drifted from actual behavior:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the API docs and the vortex-integration agent skill to reflect current multi-corridor support (BRL/EUR/USD/MXN/COP/ARS) and the user-linked sk_* requirement for ramp registration, and adds an SEO metadata source-of-truth for Apidog pages.
Changes:
- Adds per-page
seometadata todocs/api/apidog/page-manifest.jsonand documents the manual Apidog SEO workflow indocs/api/README.md. - Updates corridor and lifecycle documentation to describe per-corridor fiat settlement timing (PIX/SEPA released after update; bank-transfer corridors provide instructions after start).
- Rewrites the
vortex-integrationskill to reflect all live corridors, updated sandbox host, and new EUR/bank-transfer recipes.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/api/README.md | Documents the new SEO manifest convention and manual Apidog application process. |
| docs/api/pages/13-kyb-deep-link.md | Updates Brazil KYB wording and clarifies BRL onboarding reference. |
| docs/api/pages/12-ai-agent-integration.md | States all corridors are supported and updates fiat settlement/start sequencing guidance. |
| docs/api/pages/09-fiat-corridors.md | Clarifies BRL user identity derivation and taxId deprecation/cross-check behavior. |
| docs/api/pages/06-quotes-and-pricing.md | Updates quote response example to flattened fee fields + USD-denominated fee components. |
| docs/api/pages/04-ramp-lifecycle.md | Documents buy-side payment-instruction release timing and corridor-dependent start ordering. |
| docs/api/pages/03-authentication-and-partner-keys.md | Simplifies key-scope guidance: ramp registration requires user-linked sk_* in all corridors. |
| docs/api/pages/02-quick-start-with-the-sdk.md | Removes taxId from SDK examples and clarifies PIX payout recipient behavior. |
| docs/api/pages/01-overview.md | Updates step overview to describe fiat settlement across all corridors. |
| docs/api/apidog/page-manifest.json | Adds seo blocks (metaTitle/metaDescription/keywords) for each Apidog page entry. |
| .agents/skills/vortex-integration/SKILL.md | Updates corridor reality, adds EUR/bank-transfer recipes, fixes sandbox URL, and revises error guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
156
to
160
| "quoteId": "QUOTE_ID", | ||
| "ephemeralAccounts": [ | ||
| { "type": "EVM", "address": "0x..." }, | ||
| { "type": "Substrate", "address": "5..." }, | ||
| { "type": "Stellar", "address": "G..." } |
Comment on lines
182
to
185
| - `KycInvalidError` — KYC exists but is not approved. | ||
| - `AmountExceedsLimitError` — quote amount above the user's KYC tier limit. | ||
| - `MissingBrlParametersError` — `destinationAddress` or `taxId` missing. | ||
| - `MissingBrlParametersError` — `destinationAddress` missing. | ||
| - `QuoteExpiredError` — re-quote and call `registerRamp` again. |
Comment on lines
242
to
244
| ## Common failures | ||
| - `MissingBrlOfframpParametersError` — `receiverTaxId`, `pixDestination`, or `taxId` missing. | ||
| - `MissingBrlOfframpParametersError` — `pixDestination` or `walletAddress` missing. | ||
| - `InvalidPixKeyError` — PIX key format invalid or unreachable. Validate beforehand with `GET /v1/brla/validatePixKey`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the partner docs and the
vortex-integrationskill in line with what the SDK actually supports today (all six fiat corridors), and adds SEO metadata for the Apidog docs site.SEO
docs/api/apidog/page-manifest.jsonnow carries anseoblock (metaTitle,metaDescription,keywords) targeting integrator search intent. Apidog has no API for SEO settings, so these are the repo source of truth to be applied manually in the Apidog UI (Page → SEO Settings).docs/api/README.md(§ SEO Settings).AI Agent Integration page (
12-ai-agent-integration.md)ibanPaymentDataat register (EUR),achPaymentDataafter start (USD/MXN/COP/ARS), plus per-corridor payout rails on sells.vortex-integrationskillVerified against the SDK source before rewriting:
start-ramp-eur-sepaandstart-ramp-bank-transfer(incl.listAlfredpayFiatAccounts,achPaymentData, user-linkedsk_*key requirement,FiatToken.EURCgotcha).taxIddeprecation (derived server-side from the user-linked key) and thesubmitUserTransactionshelper.InsufficientBalanceError,MykoboKycRequiredError,AlfredpayOnrampKycRequiredError, and the ephemeral-freshness errors.api.sandbox.vortexfinance.codoes not resolve; the live host isapi-sandbox.vortexfinance.co(matches the OpenAPIserversentry; confirmed with an HTTP probe).Notes for reviewers
Verification
bun run docs:api:checkpasses for the changed files (the known pre-existing sandbox-page finding is untouched).bun lintclean.