Segurança e respostas

Boas práticas de autenticação, proteção de credenciais e semântica de retorno da API REST da Plataforma Yep.

Hardening Partial success Semântica

Visão geral

A API recebeu endurecimentos importantes de autenticação, armazenamento de segredos, auditoria e semântica de retorno. Esta página resume os principais comportamentos esperados por integradores.

Boas práticas de segurança

Armazene client_id, client_secret, access token e refresh token em ambiente seguro.
Não exponha credenciais em logs locais, prints ou ferramentas de monitoramento sem mascaramento.
Use sempre o fluxo OAuth padrão documentado.
Rotacione o client_secret em caso de suspeita de exposição.

Semântica de resposta

Três estados cobrem todos os cenários de retorno para operações de escrita na API.

Cenário	`success`	`partial_success`	Interpretação
Payload totalmente válido	`true`	`false`	Atualização aplicada integralmente.
Parte válida e parte inválida	`true`	`true`	Atualização parcial com itens ignorados.
Nada aproveitado	`false`	`false`	Falha total — nenhum dado útil salvo.

Estruturas de erro e alerta

Quando aplicável, a API pode retornar três blocos de diagnóstico:

invalid_fields

Chaves inválidas no payload raiz.

invalid_attributes

Atributos inexistentes em additional_attributes.

invalid_attribute_values

Valores inválidos, opções inexistentes, categorias inexistentes e relacionamentos inválidos.