Versionamento

A Partner API é versionada na URL. A versão atual é:

https://partner-api.performancehub.co/partner/v1/

Política de alterações

O Performance Hub busca fazer alterações aditivas e compatíveis com versões anteriores sempre que possível.

Exemplos de alterações compatíveis com versões anteriores:

• Adicionar um novo campo opcional a uma solicitação.
• Adicionar um novo campo a uma resposta.
• Adicionar um novo endpoint.
• Adicionar um novo valor de enumeração quando se espera que os clientes tratem valores desconhecidos.
• Melhorar as mensagens de validação sem alterar o contrato dos códigos de status.

access_time_windows e access_time_windows_revision são campos aditivos da solicitação de membro. Os clientes existentes que os omitem mantêm inalterado o snapshot de Access Time Windows armazenado. Essa regra de omissão preserva a compatibilidade com upserts parciais; omitir não equivale a enviar uma matriz vazia.

Exemplos de alterações incompatíveis:

• Remover ou renomear um campo.
• Alterar o tipo de um campo.
• Tornar obrigatório um campo de solicitação opcional.
• Remover um endpoint.
• Alterar o significado de um código de status existente ou de um reason específico do domínio.

Descontinuações

Quando uma alteração incompatível for necessária, o Performance Hub evitará, sempre que possível, alterar a versão existente diretamente. Em vez disso, introduziremos uma nova versão ou um caminho de migração e comunicaremos a alteração aos parceiros afetados.

Os avisos de descontinuação podem incluir:

• Uma entrada no registro de alterações.
• Comunicação direta com os parceiros.
• Observações no Partner Console.
• Orientações de migração na documentação.

Recomendações para clientes

Crie clientes que tolerem alterações aditivas:

• Ignore os campos de resposta que você não usa.
• Trate valores de enumeração desconhecidos como não compatíveis, em vez de deixar o cliente falhar.
• Evite verificações estritas de igualdade das respostas.
• Registre valores não reconhecidos para que você possa atualizar sua integração de forma intencional.

Para partições de membro com revisão, como as Access Time Windows, mantenha a revisão enviada e o payload normalizado até que o resultado seja conhecido. Reutilizar uma revisão para um conteúdo alterado é um conflito, enquanto repetir o mesmo conteúdo é idempotente. Consulte Access Time Windows.

Especificações OpenAPI

Use as especificações OpenAPI publicadas para gerar clientes, validar solicitações e acompanhar as mudanças na estrutura da API ao longo do tempo.

Consulte Especificações OpenAPI.