API REST da Plataforma Yep

Referência técnica para integrações homologadas. OAuth 2.0, catálogo, operação e segurança — documentação estruturada por domínio funcional, pronta para uso em equipes de integração, ERP e homologação.

OAuth 2.0 Catálogo Estoque Preços Segurança 2026

Uma documentação corporativa para a sua API

Esta versão foi organizada para publicação direta no site da Plataforma Yep, com navegação por domínio funcional, linguagem institucional e foco prático para times de integração. O conteúdo consolida os endpoints já disponíveis, os fluxos OAuth e os endurecimentos recentes de validação, segurança e operação.

100%

CompatívelEndpoints no mesmo formato já homologado.

OAuth

Autenticação reforçadaProteção de segredos e auditoria sanitizada.

Fila

Processamento robustoEstoque e preços com maior previsibilidade.

Docs

Pronta para expansãoPreparada para clientes, pedidos, status e rastreio.

Navegação rápida

Atalhos para os principais módulos da documentação da API REST.

ComeçandoPré-requisitos, token OAuth e primeira chamada autenticada. OAuth 2.0Obtenção de token, refresh token e healthcheck. ProdutosCriação, atualização, consulta, exclusão, vínculo e imagens. PreçosPreço base, preço promocional e preço por grupo. Atributos e estruturaAttribute sets, groups, atributos globais e vínculo com estrutura. Segurança e respostasBoas práticas, partial_success e semântica de retorno.

O que esta documentação cobre

Escopo funcional organizado em cinco domínios principais.

Área	Conteúdo	Uso principal
Guia geral	Introdução, getting started e novidades	Onboarding técnico e visão institucional
Autenticação	Bearer Token, OAuth 2.0, refresh e healthcheck	Autorização de integrações
Catálogo	Produtos, estoque, preços, categorias, atributos e opções	Operação central da API
Operação	Reindex manual, segurança e semântica de respostas	Suporte, troubleshooting e homologação
Roadmap	Clientes, pedidos, status e rastreio	Planejamento e comunicação com integradores