vtex-io-client-integration

Official

Guides VTEX IO client integrations.

Authorvtex
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Enables VTEX IO backend teams to determine and implement the correct client strategy for integrating with VTEX services and external APIs using the VTEX IO client abstractions, ensuring consistent authentication, retries, and observability.

Core Features & Use Cases

  • Client strategy guidance: helps decide when to use native VTEX clients, JanusClient, or ExternalClient.
  • IOClients pattern enforcement: promotes registering clients in IOClients and accessing them via ctx.clients.
  • Best practices & guardrails: codifies instance options, headers, metrics, and error handling to reduce misconfigurations.
  • Use case examples: among back-end modules integrating with core VTEX services or external APIs.

Quick Start

Install and configure the VTEX IO client integration pattern in your backend project.

Dependency Matrix

Required Modules

None required

Components

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: vtex-io-client-integration
Download link: https://github.com/vtex/ai-skills/archive/main.zip#vtex-io-client-integration

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.