A API aberta suporta dois modelos de autenticação. Novas integrações devem usar OAuth. Integrações legadas podem continuar com API Key, mas recomendamos migrar para OAuth.
Comparativo
OAuth
O estabelecimento instala o app na CW App Store e autoriza os escopos solicitados. O app recebe tokens vinculados à instalação: o vínculo entre um app e um estabelecimento específico, com os escopos concedidos na autorização. Cada loja instalada gera credenciais OAuth próprias.
API Key (legado)
O estabelecimento gera um token no Portal (Configurações → Integrações → API) e o compartilha com o sistema externo. Dependendo do módulo, também pode ser exigido o X-PARTNER-KEY da integradora (por exemplo, em todo o módulo Catálogo e em endpoints específicos de Loja e Pedidos).
Para publicar na CW App Store, migre para OAuth.
Quando cada modelo se aplica
O modelo de autenticação não é uma escolha livre: ele depende do tipo de integração.
