headless-bff-architecture
OfficialDesign a secure BFF layer for headless VTEX apps.
Authorvtexdocs
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Securely proxy VTEX private APIs through a server-side BFF to prevent exposure of API keys and shopper credentials in frontend code, enabling safe, authenticated communication with VTEX services.
Core Features & Use Cases
- Mandatory BFF layer for all headless VTEX projects to centralize API calls and credential management.
- Server-side handling of VtexIdclientAutCookie and API keys to protect shopper sessions and machine credentials.
- Clear routing rules for public vs private VTEX endpoints, with validation and security guardrails.
- Per-module API key separation and credential management to minimize risk and scope.
Quick Start
Install a minimal Express-based BFF, configure server-side VTEX credentials via environment variables, and route private VTEX endpoints through the BFF.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: headless-bff-architecture Download link: https://github.com/vtexdocs/ai-skills/archive/main.zip#headless-bff-architecture Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.