Acesso à API e autenticação

SPREEAI fornece uma referência de API pública para fluxos de trabalho de parceiros aprovados: https://docs.spreeai.com/swagger/public/.

Modelo de acesso

O escopo da API, o ambiente, as credenciais e as operações permitidas são definidos durante o processo de integração do parceiro. Não presuma que um endpoint interno, de desenvolvimento ou histórico esteja disponível em produção.

Regras de credenciamento

Armazene segredos do cliente e tokens de acesso somente em um repositório de segredos seguro no servidor.
Nunca inclua credenciais no Git, na documentação, nos sistemas de rastreamento de problemas, nas capturas de tela ou nos aplicativos de exemplo.
Nunca envie credenciais para plataformas de análise ou de registro de logs.
Utilize credenciais específicas do ambiente somente no ambiente para o qual foram emitidas.
Se uma credencial for exposta, troque-a imediatamente.
Redigir cabeçalhos e tokens de autorização de solicitações de suporte.

Navegador versus servidor

O SDK Web utiliza a configuração do navegador fornecida pelo parceiro. Não é necessário incluir um segredo do cliente no navegador.

As integrações do lado do servidor devem seguir o fluxo de autenticação e as definições de endpoint na referência de API aprovada atual. Quando uma operação necessária estiver ausente, solicite-a por meio da Engenharia de Parceiros em vez de criar uma rota não documentada.

Webhooks

Os webhooks de notificação push do servidor não fazem parte da documentação do SDK Web atualmente publicada. Confirme qualquer requisito de webhook antes de projetar uma dependência dele.

Lista de verificação ambiental

[ ] O nome do ambiente está documentado.
[ ] O URL base veio da referência aprovada ou da transferência de integração.
[ ] Credenciais foram emitidas para esse ambiente.
[ ] Os segredos são armazenados no servidor.
[ ] Os registros ocultam tokens e imagens do cliente.
[ ] Tempos limite, novas tentativas e comportamento de idempotência foram acordados para operações de escrita.
[ ] Um teste de não produção é bem-sucedido antes que o acesso de produção seja usado.