Introdução

Visão geral da API REST da Plataforma Yep e da organização deste portal de documentação técnica.

Visão geral Princípios Integrações

Sobre esta documentação

Este portal foi criado para substituir o modelo antigo de manual técnico estático e reorganizar a documentação da API REST da Plataforma Yep em um formato moderno, claro e pronto para publicação em site corporativo. O conteúdo parte do material HTML anterior e consolida as melhorias recentes já realizadas na API, incluindo OAuth 2.0, respostas parciais e endurecimentos de segurança.

Escopo atual

A documentação cobre autenticação, produtos, estoque, preços, categorias, atributos, opções customizadas, reindex manual e boas práticas de segurança.

Princípios da API

Pilares que orientam a evolução da API e garantem previsibilidade para integradores.

Compatibilidade com integrações já homologadas — sem quebras silenciosas de contrato.
Autenticação via OAuth 2.0 com Bearer Token e refresh seguro.
Suporte a partial_success quando parte do payload é aproveitada e parte ignorada.
Operação robusta para cenários de alto volume, com fila e processamento controlado.
Semântica clara de erros com invalid_fields, invalid_attributes e invalid_attribute_values.

Como navegar

A documentação está organizada em cinco domínios funcionais. Escolha um ponto de entrada:

ComeçandoPrimeira chamada autenticada em minutos. OAuth 2.0Token, refresh e healthcheck. ProdutosCRUD, vínculo e imagens. SegurançaSemântica e boas práticas.