tray-api

Plugin Tray API para ferramentas de IA

Plugin completo para integração com as APIs da Tray. Acelera o desenvolvimento de aplicativos e-commerce por parceiros e comunidade na plataforma Tray, fornecendo documentação detalhada de 150+ endpoints, fluxos de autenticação OAuth, webhooks e boas práticas de integração.

Plugin licenciado sob MIT. Antes de abrir issue de segurança, leia SECURITY.md. Para contribuir, leia CONTRIBUTING.md.

Funciona nativamente com Claude Code, Cursor, OpenAI Codex, Google Gemini CLI, GitHub Copilot, JetBrains AI Assistant e Windsurf.

Pré-requisitos

• Credenciais de API Tray (Consumer Key e Consumer Secret) — obtidas em developers.tray.com.br

Instalação por ferramenta através do CLI

Instalação via pacote Node (recomendado para projetos locais)

Adicione o plugin como dependência de desenvolvimento no seu repositório:

npm install --save-dev github:tray-tecnologia/tray-api-ai-plugin
# ou
pnpm add -D github:tray-tecnologia/tray-api-ai-plugin
# ou
bun add -d github:tray-tecnologia/tray-api-ai-plugin

O pacote será instalado em node_modules/@tray-tecnologia/tray-api-plugin/ e pode ser referenciado pelas ferramentas que suportam contexto por arquivos locais.

Claude Code (instalação nativa via plugin)

# Via marketplace
/plugin marketplace add tray-tecnologia/tray-api-ai-plugin
/plugin install tray-api@tray-plugins

# Desenvolvimento local
git clone https://github.com/tray-tecnologia/tray-api-ai-plugin.git
claude --plugin-dir ./tray-api-ai-plugin

Cursor

Opção 1 (recomendada): instalar via pacote Node e apontar o rule file para o projeto.

cp node_modules/@tray-tecnologia/tray-api-plugin/.cursor/rules/tray-api.mdc .cursor/rules/tray-api.mdc

Opção 2: clone ou submódulo no projeto de integração. O arquivo .cursor/rules/tray-api.mdc é carregado automaticamente quando o Cursor abre o repositório.

git submodule add https://github.com/tray-tecnologia/tray-api-ai-plugin.git .tray-plugin

O Cursor passa a ter acesso a todos os skills via @skills/ e aos agentes via @agents/.

OpenAI Codex CLI

Opção 1 (recomendada): usar o pacote instalado e importar o AGENTS.md no contexto do seu projeto.

cp node_modules/@tray-tecnologia/tray-api-plugin/AGENTS.md ./

Opção 2: clone ou submódulo. O AGENTS.md na raiz é carregado automaticamente pelo Codex.

git submodule add https://github.com/tray-tecnologia/tray-api-ai-plugin.git .tray-plugin

Google Gemini CLI

Opção 1 (recomendada): usar o pacote instalado e copiar o contexto GEMINI.md.

cp node_modules/@tray-tecnologia/tray-api-plugin/GEMINI.md ./

Opção 2: clone ou submódulo. O GEMINI.md na raiz é carregado automaticamente via sistema hierárquico de contexto.

git submodule add https://github.com/tray-tecnologia/tray-api-ai-plugin.git .tray-plugin
# Verificar contexto carregado:
/memory show

GitHub Copilot (VS Code)

O arquivo .github/copilot-instructions.md deste repositório é reconhecido automaticamente pelo Copilot quando o projeto é aberto no VS Code.

JetBrains AI Assistant

O arquivo .aiassistant/rules/tray-api.md é detectado automaticamente como project rule pelo JetBrains AI Assistant.

Windsurf (Cascade)

O AGENTS.md na raiz é reconhecido automaticamente pelo Cascade como regra always-on.

Componentes

Componente	Quantidade	Descrição
Skills	35	1 skill de entrada (regras invariantes da API) + 34 skills com a documentação de cada recurso
Agentes	10	Fluxos especializados (setup, catálogo, pedidos, debug, migração + 5 especialistas por plataforma)
Comandos	3	Atalhos rápidos (setup, referência, validação)
Hooks	2	Validação automática de segurança

Skills Disponíveis

Entrada (carregar primeiro)

visao-geral — regras invariantes da API Tray (OAuth, payload com chave do recurso, rate limit, dados BR)

Base

autorizacao, webhooks, produtos, variacoes, imagens-produtos, categorias, pedidos, clientes, informacoes-loja

Complementar

caracteristicas, marcas, kits, status-pedido, enderecos-cliente, perfis-cliente, frete, configuracao-frete, multicd, notas-fiscais, pagamentos